Content can be written in various markup languages (currently Markdown, reStructuredText, and Textile), with a YAML header, separated by 3 hyphens alone on a line. For example:

title: Sample Post
author: Mike Cooper <mythmon@gmail.com>
---
The content of the page.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec
pellentesque, est non hendrerit mattis, arcu nibh venenatis sapien, quis
porta sem libero placerat magna. Suspendisse condimentum turpis fringilla
ligula porta vestibulum et ut sem. Cras hendrerit pulvinar metus at
imperdiet.

For more details on how to work with renderers, see the docs about renderers.

Metadata¶

These are the variables that affect the rending, layout, and categorization of pages in the YAML metadata.

• title - The title of the page. If not specified, the filename (minus .mkd) will be used.
• type - Used to determine the template to use. If unspecified, the template default is used.
• author - In My Name <my@email.com> format.
• slug - Name for URLs and filenames. If not specified, it will be generated from the title.

• date, time, or datetime - Published date in ISO8601 format (ie: 2011-02-17 14:31:00).

  Note that due to the way the YAML standard works, seconds are required in date times and times, other wise they will not be parsed correctly.

• category - Including sub categories as a slash-separated list. projects/wok/docs means the page is in the category docs which is a subcategory of wok which is a subcategory of projects.

• tags - A comma-separated list of tags, e.g., foo, bar, herp, derp. (More about tagging)
• published - To exclude some pages from the site, but not remove them entirely.
• url - To manually specify the path for the generated page. If none is specified, the global pattern defined in url_pattern in the main configuration file will be used. (More about managing URLs)
• pagination - An object who's presence will trigger paginating this page. See pagination for more details.

Categories¶

Categories in wok can be treated as a tree, where every node is a page. There are no seperate categories and pages, there are just pages, and sub-pages, and sub-sub-pages, etc. For more infomation, see the category docs.

Syntax Highlighting¶

wok can use Pygments to do syntax highlighting. It will be automatically enabled if you mark a block of text as code, and assign it a language. Marking a block of text is different in each mark up language.

For more details, see how to do it in each renderer here.