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

Add some explanations about the theme templates.

Browse source
This commit is contained in:
Alexis Metaireau 2010-12-15 18:08:25 +00:00
commit 2f38fab3e0
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/themes.rst
View file

@ -43,6 +43,8 @@ are in caps. You can access them directly.
Common variables Common variables
---------------- ----------------
All of those settings will be given to all templates.
============= =================================================== ============= ===================================================
Variable Description Variable Description
============= =================================================== ============= ===================================================
@ -62,6 +64,9 @@ pages The list of pages
category.html category.html
------------- -------------
This template will be processed for each of the existing categories, and will
finally remain at output/category/`category_name`.html.
============= =================================================== ============= ===================================================
Variable Description Variable Description
============= =================================================== ============= ===================================================
@ -72,6 +77,9 @@ category The name of the category being processed
article.html article.html
------------- -------------
This template will be processed for each article. .html files will be outputed
in output/`article_name`.html. Here are the specific variables it gets.
============= =================================================== ============= ===================================================
Variable Description Variable Description
============= =================================================== ============= ===================================================
@ -82,6 +90,9 @@ category The name of the category of the current article
tag.html tag.html
-------- --------
For each tag, this template will be processed. It will create .html files in
/output/tag/`tag_name`.html
============= =================================================== ============= ===================================================
Variable Description Variable Description
============= =================================================== ============= ===================================================