README.md in academic-0.1.0 vs README.md in academic-0.1.1
- old
+ new
@@ -1,8 +1,9 @@
# academic
-Academic is a theme with a focus on simplicity, typography and flexibility. I originally designed for my personal blog during my PhD thesis.
+Academic is a [Jekyll](http://jekyllrb.com/) theme with a focus on simplicity, typography and flexibility.
+I originally designed it for my personal blog during my PhD thesis.
**Simplicity**: both in design and configuration, Academic aims to let the writer and its readers focus on the content.
@@ -26,10 +27,11 @@
* [Layouts](#layouts)
* [Post layout](#post-layout)
* [Page layout](#page-layout)
* [About layout](#about-layout)
* [Archive layout](#archive-layout)
+ * [404 layout](#404-layout)
* [Contributing](#contributing)
* [Release log](#release-log)
* [License](#license)
## Features
@@ -114,13 +116,16 @@
`description`: [recommended] short description for search engines. It's displayed in the footer of every page. Not to be confused with `pitch`.
`cc`: [optional] choose among the [Creative Commons](https://creativecommons.org/licenses/) licenses (v4). Accepted values are : `by`, `by-sa`, `by-nd`, `by-nc`, `by-nc-sa`, `by-nc-nd`. Defining the `cc` variable will add a small sentence in the footer. If no value is given, a small copyright is added instead.
-
`dateformat`: [optional] format the dates of the whole website. Default "%b %-d, %Y". Read [the documentation](https://help.shopify.com/themes/liquid/filters/additional-filters#date) to learn how you can customize the date format.
+`nb_posts_page`: [optional] number of posts to display on the homepage. By default, all posts are listed. Note that you should create a page with the archive layout.
+
+`archive_permalink`: [optional] permalink of the archive page. Set to `"/archive"` by default.
+
#### Author
`email`: [optional] add email address in about layout.
`curriculum`: [optional]
@@ -179,18 +184,29 @@
Will automatically put the content of the page on the right column. The left column will automatically be filled with the author info provided in the `_config.yml`.
#### Archive layout
-Pages with the archive layout will list all posts published in reverse chronological order.
+Create a `archive.md` page, choose the "archive" layout. You don't need to write anything in this file, all posts published will be listed in reverse chronological order.
+#### 404 layout
+
+Create a `404.md` page, set the layout:
+
+```
+layout: pagenotfound
+```
+
+The content of the page will be used in the 404 page.
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/gaalcaras/academic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Release log
-+ 0.1.0 : first release of the theme.
++ 0.1.1 [2016-12]: bug fixes
++ 0.1.0 [2016-12]: first release of the theme.
## License
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).