Warning: This documentation is only compatible with version 1.0 and newer.
Below is a typical
# Maximum number of words to use in a blurb blurb_max: 50 # The default home page to be written as docroot/index.html home_page: home.md site: # The site title, used in <title> title: My PyKwiki Project # Author for use in meta name=author author: Example Author # Description for use in meta name=description description: "Example Site Description goes here" # Keywords for use in meta name=keywords keywords: "example, pykwiki" # (new in v1.0.5) Base URL is used by RSS feeds, no web_prefix base_url: http://www.example.com # Theme is a subdirectory of themes/ theme: default # Web prefix, must not end with "/" web_prefix: '' # The project's directory base_path: /home/HarryPotter/MyPyKwikiProject/ # The date format used by posts date_format: '%B %d, %Y' # The time format used by posts time_format: '%H:%M:%S' # The timestamp format used by posts, this must match # the format found in the post data block, if specified timestamp_format: '%Y-%m-%d %H:%M' # Post list section postlist: # How many posts to show per page per_page: 5 # Maximum number of pages to render max_pages: 20 # What type of post data to display (blurb, preview, full) post_type: preview # What field to order posts by (mtime, title) order_field: mtime # What direction to order posts (descending, ascending) order_type: descending
blurb_max- specifies how many words of a post should be shown.
home_page- Tells PyKwiki to look for this post in the
sourcedirectory, and if found, save it to
web_prefix- This should be an empty string if not specified. Themes prepend this value to all site links. This is usefull for serving multiple PyKwiki projects from the same docroot directory.
base_path- This is the full path to your PyKwiki Project's directory.
site- Generate site settings
title- The human readable site title. Most themes will populate the html
<title>attribute with this value.
author- Most themes put this value in
description- Most themes use this value in
keywords- This is a string of keywords that some themes use in
base_url- This is the base url of your site without a trailing slash or web prefix.
date_format- This describes how the date will appear when themes lookup a post's date. It uses strftime formatting.
time_format- This describes how the time will appear when themes lookup a post's time. It uses strftime formatting.
timestamp_format- This describes how the date and time will appear when themes lookup a post's timestamp.It also uses strftime formatting.