github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Documentation changes based on pull request comments.

Browse source 
- Settings -> Template pages: DIRECT_TEMPLATES example
- Creating Themes -> Common variables: authors and tags descriptions
This commit is contained in:
Boian Berberov 2019-04-04 17:11:58 -06:00
commit 4f49428961
2 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/settings.rst
View file

@ -728,12 +728,12 @@ Template pages
The extensions to use when looking up template files from template names. The extensions to use when looking up template files from template names.
.. data:: DIRECT_TEMPLATES = ['index', 'tags', 'categories', 'authors', 'archives'] .. data:: DIRECT_TEMPLATES = ['index', 'authors', 'categories', 'tags', 'archives']
List of templates that are used directly to render content. Typically direct List of templates that are used directly to render content. Typically direct
templates are used to generate index pages for collections of content (e.g., templates are used to generate index pages for collections of content (e.g.,
tags and category index pages). If the tag and category collections are not category and tag index pages). If the author, category and tag collections are not
needed, set ``DIRECT_TEMPLATES = ['index', 'authors', 'archives']`` needed, set ``DIRECT_TEMPLATES = ['index', 'archives']``
``DIRECT_TEMPLATES`` are searched for over paths maintained in ``DIRECT_TEMPLATES`` are searched for over paths maintained in
``THEME_TEMPLATES_OVERRIDES``. ``THEME_TEMPLATES_OVERRIDES``.

4
docs/themes.rst
View file

@ -82,11 +82,11 @@ dates The same list of articles, but ordered by date,
ascending. ascending.
drafts The list of draft articles drafts The list of draft articles
authors A list of (author, articles) tuples, containing all authors A list of (author, articles) tuples, containing all
the authors. the authors and corresponding articles (values)
categories A list of (category, articles) tuples, containing categories A list of (category, articles) tuples, containing
all the categories and corresponding articles (values) all the categories and corresponding articles (values)
tags A list of (tag, articles) tuples, containing all tags A list of (tag, articles) tuples, containing all
the tags. the tags and corresponding articles (values)
pages The list of pages pages The list of pages
hidden_pages The list of hidden pages hidden_pages The list of hidden pages
draft_pages The list of draft pages draft_pages The list of draft pages