From 5e4257c91be07ef001052965d59e6888ee87ea3c Mon Sep 17 00:00:00 2001 From: Dan Crosta Date: Wed, 6 May 2015 22:40:34 -0400 Subject: [PATCH] update README --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f846ded..b43acac 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ -# Author Pages +# Auto Pages -This plugin adds an attribute `page` to the author object which can be used -in templates by themes. The page is processed as an ordinary Pelican page, -so it can be Markdown, reStructuredText, etc. +This plugin adds an attribute `page` to the author, category, and tag +objects which can be used in templates by themes. The page is processed as +an ordinary Pelican page, so it can be Markdown, reStructuredText, etc. ## Configuration -| Setting | Default | Notes | -|--------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `AUTHOR_PAGE_PATH` | `authors` | The location, relative to the project root where author pages can be found. The filename of the author page minus the extension must match the Author's slug. | +| Setting | Default | Notes | +|----------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `AUTHOR_PAGE_PATH` | `authors` | The location, relative to the project root where author pages can be found. The filename of the author page minus the extension must match the Author's slug. | +| `CATEGORY_PAGE_PATH` | `categories` | The location, relative to the project root where category pages can be found. The filename of the category page minus the extension must match the Category's slug. | +| `TAG_PAGE_PATH` | `tags` | The location, relative to the project root where tag pages can be found. The filename of the tag page minus the extension must match the Tag's slug. | ## Template Variables -| Setting | Notes | -|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `author.page` | The location, relative to the project root where author pages can be found. The filename of the author page minus the extension must match the Author's slug. | +| Variable | Notes | +|-----------------|--------------------------------------------| +| `author.page` | The rendered content of the author page. | +| `category.page` | The rendered content of the category page. | +| `tag.page` | The rendered content of the tag page. |