aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatthieu OLIVIER <molivier@users.noreply.github.com>2015-02-19 15:06:38 +0100
committerMatthieu OLIVIER <molivier@users.noreply.github.com>2015-02-19 15:06:38 +0100
commit4756e957754ec4f5948d730549ecaa261ce43901 (patch)
tree09d5385c726853a2edbcbf8a35923b31bdf777c0 /README.md
parentacce94dbe7c86790169d2142519d3b1f421ee383 (diff)
Corrected readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md164
1 files changed, 82 insertions, 82 deletions
diff --git a/README.md b/README.md
index 64318de..c01835b 100644
--- a/README.md
+++ b/README.md
@@ -50,88 +50,88 @@ Nest template can be customized by adding parameters to your `pelicanconf.py` fi
### Pelican.conf example
- ```python
- # NEST Template
- THEME = 'nest'
- SITESUBTITLE = u'My Awesome Blog'
- # Minified CSS
- NEST_CSS_MINIFY = True
- # Add items to top menu before pages
- MENUITEMS = [('Homepage', '/'),('Categories','/categories.html')]
- # Add header background image from content/images : 'background.jpg'
- NEST_HEADER_IMAGES = ''
- # Footer
- NEST_SITEMAP_COLUMN_TITLE = u'Sitemap'
- NEST_SITEMAP_MENU = [('Archives', '/archives.html'),('Tags','/tags.html'), ('Authors','/authors.html')]
- NEST_SITEMAP_ATOM_LINK = u'Atom Feed'
- NEST_SITEMAP_RSS_LINK = u'RSS Feed'
- NEST_SOCIAL_COLUMN_TITLE = u'Social'
- NEST_LINKS_COLUMN_TITLE = u'Links'
- NEST_COPYRIGHT = u'&copy; blogname 2015'
- # index.html
- NEST_INDEX_HEAD_TITLE = Homepage'
- NEST_INDEX_HEADER_TITLE = u'My Awesome Blog'
- NEST_INDEX_HEADER_SUBTITLE = u'Smashing The Stack For Fun And Profit'
- NEST_INDEX_CONTENT_TITLE = u'Last Posts'
- # archives.html
- NEST_ARCHIVES_HEAD_TITLE = u'Archives'
- NEST_ARCHIVES_HEAD_DESCRIPTION = u'Posts Archives'
- NEST_ARCHIVES_HEADER_TITLE = u'Archives'
- NEST_ARCHIVES_HEADER_SUBTITLE = u'Archives for all posts'
- NEST_ARCHIVES_CONTENT_TITLE = u'Archives'
- # article.html
- NEST_ARTICLE_HEADER_BY = u'By'
- NEST_ARTICLE_HEADER_MODIFIED = u'modified'
- NEST_ARTICLE_HEADER_IN = u'in category'
- # author.html
- NEST_AUTHOR_HEAD_TITLE = u'Posts by'
- NEST_AUTHOR_HEAD_DESCRIPTION = u'Posts by'
- NEST_AUTHOR_HEADER_SUBTITLE = u'Posts archives'
- NEST_AUTHOR_CONTENT_TITLE = u'Posts'
- # authors.html
- NEST_AUTHORS_HEAD_TITLE = u'Author list'
- NEST_AUTHORS_HEAD_DESCRIPTION = u'Author list'
- NEST_AUTHORS_HEADER_TITLE = u'Author list'
- NEST_AUTHORS_HEADER_SUBTITLE = u'Archives listed by author'
- # categories.html
- NEST_CATEGORIES_HEAD_TITLE = u'Categories'
- NEST_CATEGORIES_HEAD_DESCRIPTION = u'Archives listed by category'
- NEST_CATEGORIES_HEADER_TITLE = u'Categories'
- NEST_CATEGORIES_HEADER_SUBTITLE = u'Archives listed by category'
- # category.html
- NEST_CATEGORY_HEAD_TITLE = u'Category Archive'
- NEST_CATEGORY_HEAD_DESCRIPTION = u'Category Archive'
- NEST_CATEGORY_HEADER_TITLE = u'Category'
- NEST_CATEGORY_HEADER_SUBTITLE = u'Category Archive'
- # pagination.html
- NEST_PAGINATION_PREVIOUS = u'Previous'
- NEST_PAGINATION_NEXT = u'Next'
- # period_archives.html
- NEST_PERIOD_ARCHIVES_HEAD_TITLE = u'Archives for'
- NEST_PERIOD_ARCHIVES_HEAD_DESCRIPTION = u'Archives for'
- NEST_PERIOD_ARCHIVES_HEADER_TITLE = u'Archives'
- NEST_PERIOD_ARCHIVES_HEADER_SUBTITLE = u'Archives for'
- NEST_PERIOD_ARCHIVES_CONTENT_TITLE = u'Archives for'
- # tag.html
- NEST_TAG_HEAD_TITLE = u'Tag archives'
- NEST_TAG_HEAD_DESCRIPTION = u'Tag archives'
- NEST_TAG_HEADER_TITLE = u'Tag'
- NEST_TAG_HEADER_SUBTITLE = u'Tag archives'
- # tags.html
- NEST_TAGS_HEAD_TITLE = u'Tags'
- NEST_TAGS_HEAD_DESCRIPTION = u'Tags List'
- NEST_TAGS_HEADER_TITLE = u'Tags'
- NEST_TAGS_HEADER_SUBTITLE = u'Tags List'
- NEST_TAGS_CONTENT_TITLE = u'Tags List'
- NEST_TAGS_CONTENT_LIST = u'tagged'
- # Static files
- STATIC_PATHS = ['images', 'extra/robots.txt', 'extra/favicon.ico', 'extra/logo.svg']
- EXTRA_PATH_METADATA = {
- 'extra/robots.txt': {'path': 'robots.txt'},
- 'extra/favicon.ico': {'path': 'favicon.ico'},
- 'extra/logo.svg': {'path': 'logo.svg'}
- }
- ```
+```python
+# NEST Template
+THEME = 'nest'
+SITESUBTITLE = u'My Awesome Blog'
+# Minified CSS
+NEST_CSS_MINIFY = True
+# Add items to top menu before pages
+MENUITEMS = [('Homepage', '/'),('Categories','/categories.html')]
+# Add header background image from content/images : 'background.jpg'
+NEST_HEADER_IMAGES = ''
+# Footer
+NEST_SITEMAP_COLUMN_TITLE = u'Sitemap'
+NEST_SITEMAP_MENU = [('Archives', '/archives.html'),('Tags','/tags.html'), ('Authors','/authors.html')]
+NEST_SITEMAP_ATOM_LINK = u'Atom Feed'
+NEST_SITEMAP_RSS_LINK = u'RSS Feed'
+NEST_SOCIAL_COLUMN_TITLE = u'Social'
+NEST_LINKS_COLUMN_TITLE = u'Links'
+NEST_COPYRIGHT = u'&copy; blogname 2015'
+# index.html
+NEST_INDEX_HEAD_TITLE = Homepage'
+NEST_INDEX_HEADER_TITLE = u'My Awesome Blog'
+NEST_INDEX_HEADER_SUBTITLE = u'Smashing The Stack For Fun And Profit'
+NEST_INDEX_CONTENT_TITLE = u'Last Posts'
+# archives.html
+NEST_ARCHIVES_HEAD_TITLE = u'Archives'
+NEST_ARCHIVES_HEAD_DESCRIPTION = u'Posts Archives'
+NEST_ARCHIVES_HEADER_TITLE = u'Archives'
+NEST_ARCHIVES_HEADER_SUBTITLE = u'Archives for all posts'
+NEST_ARCHIVES_CONTENT_TITLE = u'Archives'
+# article.html
+NEST_ARTICLE_HEADER_BY = u'By'
+NEST_ARTICLE_HEADER_MODIFIED = u'modified'
+NEST_ARTICLE_HEADER_IN = u'in category'
+# author.html
+NEST_AUTHOR_HEAD_TITLE = u'Posts by'
+NEST_AUTHOR_HEAD_DESCRIPTION = u'Posts by'
+NEST_AUTHOR_HEADER_SUBTITLE = u'Posts archives'
+NEST_AUTHOR_CONTENT_TITLE = u'Posts'
+# authors.html
+NEST_AUTHORS_HEAD_TITLE = u'Author list'
+NEST_AUTHORS_HEAD_DESCRIPTION = u'Author list'
+NEST_AUTHORS_HEADER_TITLE = u'Author list'
+NEST_AUTHORS_HEADER_SUBTITLE = u'Archives listed by author'
+# categories.html
+NEST_CATEGORIES_HEAD_TITLE = u'Categories'
+NEST_CATEGORIES_HEAD_DESCRIPTION = u'Archives listed by category'
+NEST_CATEGORIES_HEADER_TITLE = u'Categories'
+NEST_CATEGORIES_HEADER_SUBTITLE = u'Archives listed by category'
+# category.html
+NEST_CATEGORY_HEAD_TITLE = u'Category Archive'
+NEST_CATEGORY_HEAD_DESCRIPTION = u'Category Archive'
+NEST_CATEGORY_HEADER_TITLE = u'Category'
+NEST_CATEGORY_HEADER_SUBTITLE = u'Category Archive'
+# pagination.html
+NEST_PAGINATION_PREVIOUS = u'Previous'
+NEST_PAGINATION_NEXT = u'Next'
+# period_archives.html
+NEST_PERIOD_ARCHIVES_HEAD_TITLE = u'Archives for'
+NEST_PERIOD_ARCHIVES_HEAD_DESCRIPTION = u'Archives for'
+NEST_PERIOD_ARCHIVES_HEADER_TITLE = u'Archives'
+NEST_PERIOD_ARCHIVES_HEADER_SUBTITLE = u'Archives for'
+NEST_PERIOD_ARCHIVES_CONTENT_TITLE = u'Archives for'
+# tag.html
+NEST_TAG_HEAD_TITLE = u'Tag archives'
+NEST_TAG_HEAD_DESCRIPTION = u'Tag archives'
+NEST_TAG_HEADER_TITLE = u'Tag'
+NEST_TAG_HEADER_SUBTITLE = u'Tag archives'
+# tags.html
+NEST_TAGS_HEAD_TITLE = u'Tags'
+NEST_TAGS_HEAD_DESCRIPTION = u'Tags List'
+NEST_TAGS_HEADER_TITLE = u'Tags'
+NEST_TAGS_HEADER_SUBTITLE = u'Tags List'
+NEST_TAGS_CONTENT_TITLE = u'Tags List'
+NEST_TAGS_CONTENT_LIST = u'tagged'
+# Static files
+STATIC_PATHS = ['images', 'extra/robots.txt', 'extra/favicon.ico', 'extra/logo.svg']
+EXTRA_PATH_METADATA = {
+ 'extra/robots.txt': {'path': 'robots.txt'},
+ 'extra/favicon.ico': {'path': 'favicon.ico'},
+ 'extra/logo.svg': {'path': 'logo.svg'}
+}
+```
## Third-party assets