diff --git a/.travis.yml b/.travis.yml index 4c922127..3cc0201d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,7 +22,6 @@ cache: install: - pip install -r documentation/requirements.txt -- pip install -U Online-W3C-Validator - pip install -U html5validator - pip install -U pre-commit - yarn global add yaspeller diff --git a/.yaspeller.json b/.yaspeller.json index 465933cd..de61df74 100644 --- a/.yaspeller.json +++ b/.yaspeller.json @@ -29,6 +29,8 @@ "AWegnerGitHub", "Ayub", "Baskerville", + "BestAzon", + "bestazon", "bing", "Blais", "blog-o-matic", @@ -73,6 +75,7 @@ "github", "github.com", "google", + "gravatar", "gshen42", "Gómez", "Hi Talha", @@ -81,6 +84,7 @@ "https", "Iconifier.net", "ijvxwtg", + "imgur", "io", "iOS", "iranzo", diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index ac38af76..00000000 --- a/AUTHORS.md +++ /dev/null @@ -1,11 +0,0 @@ -Contributors to the Pelican Elegant project (in alphabetical order of first name): - -- [André Burgaud – andreburgaud](https://github.com/andreburgaud) -- [Brian Levin – bnice5000](https://github.com/bnice5000) -- [Matija Šuklje – silverhook](https://github.com/silverhook) -- [Miguel Lechón – debiatan](https://github.com/debiatan) -- [Rod Morehead – rmorehead](https://github.com/rmorehead) -- [Talha Mansoor – talha131](https://github.com/talha131) -- [Tshepang Lekhonkhobe – tshepang](https://github.com/tshepang) -- [calfzhou](https://github.com/calfzhou) -- [Xin Yue – yuex](https://github.com/yuex) diff --git a/documentation/content/Appearance and Style/modified-date.md b/documentation/content/Appearance and Style/modified-date.md index fa5b3fba..e50e1b93 100644 --- a/documentation/content/Appearance and Style/modified-date.md +++ b/documentation/content/Appearance and Style/modified-date.md @@ -12,18 +12,19 @@ authors: Talha Mansoor --- You need to update your articles time and again. Sometimes it makes sense to -display the date when you updated the article. You can show the last updated +display the date when you updated the article. + +Pelican release [v3.4.0](http://docs.getpelican.com/en/stable/changelog.html#id9) has a new +[ metadata field `modified`](https://github.com/getpelican/pelican/pull/1148). Type of +its value is `datetime`. + +You can show the last updated date of the article by defining `modified` in your article metadata. This is how it is displayed in the side bar, ![Modified Date]({static}/images/elegant-theme_last-modified.png) -Pelican post [version -3.3](https://github.com/getpelican/pelican/releases/tag/3.3.0) has a new -[`modified` metadata](https://github.com/getpelican/pelican/pull/1148). Type of -its value is `datetime`. - Depending on your [`DATE_FORMATS`](http://docs.getpelican.com/en/latest/settings.html#basic-settings) setting you can put modified date in your reST formatted file as @@ -33,9 +34,32 @@ setting you can put modified date in your reST formatted file as Elegant will process it and display the last updated as "Jan 22, 2014". -Previous versions do not have `modified` metadata in which case type of its -value is string. If you are using old version of Pelican, i.e 3.3 or less, make -sure you assign it a value exactly the way you want it to appear. Taking the +!!! important "Condition to Display Last Updated" + + Last Updated is only displayed if the difference between `article.modifed` + and `article.date`is more than or equal to a day. + + This means if you modify and article the same day you add it, then Last + Updated will not be displayed. + +!!! tip + + You may want to enable + [`filetime_from_git`](https://github.com/getpelican/pelican-plugins/tree/master/filetime_from_git) + Pelican plugin to auto fill the modified field for your Git commit history. + +### Deprecated + +!!! Danger "Warning: Legacy Variable" + + Pelican versions prior to 3.4 does not have `modified` metadata in which case type of its + value is string. + +If you are using old version of Pelican, i.e 3.3 or less, make +sure you assign it a value exactly the way you want it to appear. +Whatever you type, it will appear as it is. + +Taking the example from above, metadata in your reST formatted file should be, :::Rest diff --git a/documentation/content/Appearance and Style/table-of-contents.md b/documentation/content/Appearance and Style/table-of-contents.md index 2a677d93..87a72d53 100644 --- a/documentation/content/Appearance and Style/table-of-contents.md +++ b/documentation/content/Appearance and Style/table-of-contents.md @@ -8,115 +8,157 @@ Disqus_identifier: lm95rjd-how-elegant-displays-table-of-contents Subtitle: Summary: Elegant shows Table of Contents, if available, non intrusively to give a clean reading experience to the visitor Keywords: -authors: Talha Mansoor +Authors: Talha Mansoor, Jack De Winter --- [TOC] -The idea behind Elegant's design is to make reading a clean and distraction -free experience. Table of contents is important but it is not part of the -article content. Therefore, Elegant pushes out table of content to the left of -the article's main content. Its font size is relatively smaller. This way, -table of content stays visible for navigation but reader's attention to the -article stays unaffected. +The key concept driving Elegant's design is to provide a reading experience that +is clean with minimal distractions. From that point of view, providing a table of +contents does not provide any additional information, but only exists to help guide the +reader through the article. -To utilize this feature, you need to use -[extract_toc](https://github.com/getpelican/pelican-plugins) plugin. Elegant -encloses the table of content in `