diff --git a/README.txt b/README.txt index d9ef1e5ca60bae066b8bfe132e49fb6fb01f5af9..61fe6bb56ee53e5364cf9f92f7a293f34675fefc 100644 --- a/README.txt +++ b/README.txt @@ -77,6 +77,70 @@ The server uses port 8000 by default. After starting the server point you browser to the url: localhost:8000. +Customizing Configuration Settings +---------------------------------- + +Pelican has a plethora of setting; all configurable in file whose +default name is 'pelicanconf.py.' Please refer to [the settings +section](http://docs.getpelican.com/en/3.5.0/settings.html) in the +Pelican documentation. + +Here is the contents of pelicanconf.py used in the cwi project +template. Observe that the 'THEME' setting is assigned the string +'cwi':: + + #!/usr/bin/env python + # -*- coding: utf-8 -*- # + from __future__ import unicode_literals + + AUTHOR = u'M.A. Guravage' + SITENAME = u'CWI Pelican Template' + SITEURL = '' + + PATH = 'content' + + TIMEZONE = 'Europe/Amsterdam' + + DEFAULT_LANG = u'en' + + # Feed generation is usually not desired when developing + FEED_ALL_ATOM = None + CATEGORY_FEED_ATOM = None + TRANSLATION_FEED_ATOM = None + AUTHOR_FEED_ATOM = None + AUTHOR_FEED_RSS = None + + # Blogroll + LINKS = (('Pelican', 'http://getpelican.com/'), + ('Python.org', 'http://python.org/'), + ('Jinja2', 'http://jinja.pocoo.org/'),) + + # Social widget + SOCIAL = (('twitter', 'https://twitter.com/CWInl'), + ('github', 'http://github.com'),) + + STATIC_PATHS = ['static', 'images', 'extras/.htaccess', 'extras/.htpassword'] + PAGE_PATHS = ['pages','news', 'private'] + ARTICLE_PATHS = ['blog'] + + DEFAULT_PAGINATION = 10 + THEME = 'cwi' + USE_FOLDER_AS_CATEGORY = True + DISPLAY_CATEGORIES_ON_MENU = False + DISPLAY_PAGES_ON_MENU = True + LOAD_CONTENT_CACHE = False + + EXTRA_PATH_METADATA = { + 'extras/.htaccess': {'path': 'pages/.htaccess'}, + 'extras/.htpassword': {'path': 'pages/.htpassword'} + } + + # Uncomment following line if you want document-relative URLs when developing + #RELATIVE_URLS = True + + # finis + + Uploading the generated HTML to a server ---------------------------------------- @@ -303,5 +367,4 @@ Pelican Documentation ===================== You will find answers to all your Pelican questions in the Pelican -documentation. You will find the Pelican documentation at -com/en/3.5.0. +documentation. You will find the Pelican documentation at http://docs.getpelican.com/en/3.5.0/.