From e6e81d10dd2c568b961fab60a0b71f60c8862c2b Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 2 Nov 2017 18:57:10 +0100 Subject: [PATCH] Doc++ --- CONTRIBUTING.rst | 2 +- README.rst | 2 +- doc/pelican/theme.rst | 12 ++++++++++++ 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6c08af78..ac42defc 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -39,7 +39,7 @@ Code contribution /* This file is part of m.css. - Copyright © Vladimír Vondruš + Copyright © 2017 Vladimír Vondruš Copyright © YEAR YOUR_NAME Permission is hereby granted, free of charge, to any person obtaining a diff --git a/README.rst b/README.rst index 25b93cf0..6f9d1d18 100644 --- a/README.rst +++ b/README.rst @@ -69,7 +69,7 @@ Feel free to visit the project website or contact the author at: CREDITS ======= -See `CREDITS.rst `_ file for details. Big thanks to everyone +See the `CREDITS.rst `_ file for details. Big thanks to everyone involved! LICENSE diff --git a/doc/pelican/theme.rst b/doc/pelican/theme.rst index a63e936e..a1b41eed 100644 --- a/doc/pelican/theme.rst +++ b/doc/pelican/theme.rst @@ -351,6 +351,18 @@ social links: `Articles`_ =========== +Compared to pages, articles have additional metadata like :rst:`:date:`, +:rst:`:author:`, :rst:`:category:` and :rst:`tags` that order them and divide +them into various sections. Besides that, there's article :rst:`:summary:`, +that, unlike with pages, is displayed at the top of the article, along with +other metadata. + +All article listing pages (archives, categories, tags, authors) are displaying +just the article summary and the full article content is available only on the +dedicated article page. An exception to this is the main index or archive page, +where the first article is fully expanded so the users are greeted with some +actual content instead of just a boring list of article summaries. + `Jumbo articles`_ ----------------- -- 2.30.2