Changeset - 1dbc0604a90f
[Not reviewed]
0 1 0
Michael Guravage (guravage) - 11 years ago 2015-01-12 13:28:07
m.a.guravage@cwi.nl
Added settings description.
1 file changed with 65 insertions and 2 deletions:
0 comments (0 inline, 0 general)
README.txt
Show inline comments
 
@@ -74,12 +74,76 @@ you can regenerate the HTML and serve it in one command::
 
    make html serve
 

	
 
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
 
----------------------------------------
 

	
 
The Pelican Makefile contains several targets for uploading its
 
generated HTML. List all make's targets with::
 

	
 
@@ -300,8 +364,7 @@ Here is the structure of the HTML Pelican generates::
 
    │   │   │               └──  youtube.png
 

	
 
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/.
0 comments (0 inline, 0 general)