Adding posts to your PyKwiki consists of two main pieces.
pykwiki cacheto cache your content.
.mdextension unless a different extension has been specified in config.yaml (the
If you don't have access to the server, or if you prefer to use your own text editor to edit files, then you can sync files between your computer and the server.
The server needs some way to cache your files. One way
to do this is to have your server administrator setup
$ cd /path/to/myproject/source $ nano my-new-post.md
Put the following in as your page content, and save the post
[[ title: My New Post ]] # Here is a new post! * It's easy * It's fun * It's fast
The double brackets
]] indicate the post data block. Here you can specify
various information about your pages. Learn more about the post data block.
Note: Post properties in this block must be either valid
YAML or valid
PyKwiki parses the
links.yaml file to generate the site menu. Once
you understand the format of
links.yaml, adding links is very quick and easy.
$ cd /path/to/myproject $ pykwiki cache
The post data block is entirely optional, but it adds a lot of functionality
to PyKwiki. The minimal recommended fields are
This block should appear at the top of a post, and must be enclosed in
# The post title will show in search results, as well as # in the title bar of the browser. title: My Post Title # The post author is displayed by most themes. # Can be a comma separated list of multiple authors. author: Harry Potter # Post tags are essentially categories. tags: [A, YAML, List, Of, Tags] # A page description is mostly useful for search engines # but it will be used as the page blurb if none is found description: A simple description of my page, this information is usually used by themes to make your site more search engine friendly. If no blurb is specified, this will be used as the page blurb. # The page blurb can be set to "auto", which allows # PyKwiki to generate one based on the first 50 words # in the body of a page. blurb: This is my post blurb. It will be used as the short description in search results. If I want this to be autogenerated, I should set its value to "auto" for example: blurb: auto # Post keywords are used by SEO keywords: This is, a string, of comma separated words # The timestamp of the page. It MUST match the # `timestamp_format` specified in config.yaml timestamp: 2013-11-01 21:45 # Pages that are flagged as private are basically unpublished. # They are not searchable and can only be reached by a direct link. private: false # The nowrap option is used by some themes to prevent wrapping # the post content in a "container" nowrap: false