Document Structure

Documents are dived into header and body parts.

Document Header

url: /
title: Logya Documentation
template: post.html
created: 2012-03-18 13:59:16
previewimage: /path/to/previewimage.png

The header is in YAML format. It starts and ends with 3 dashes. In the header you must specify the title attribute.

You can manually set a url attribute, which must be unique and can be used to refer to a document in templates. If you omit the url it will be created from the file name, e. g. the document in content/book/chapter-1.html will get the URL /book/chapter-1/ with the file extension stripped of.

In addition there are 2 special attributes created and updated. If you set them manually, you must use the format YYYY-MM-DD HH:MM:SS as shown in the example. Otherwise both attributes will be set to the file modification time. The document index is by default sorted by the values of created in descending order.

Additional attributes such as description, scripts and style sheets are optional. Attribute values can range from simple strings to nested data structures that are automatically available in templates.

All attributes can be accessed in templates.

Reserved Variable Names

body, canonical and debug are reserved variable names, that will be set during site generation. If they are used in document headers, their values will be overwritten.

body is set to the Document Body.

canonical is set to the canonical URL of the current page including the host part and debug will be set to True in serve mode in other modes it is not set.

An example where the debug variable is useful: you want to use uncompressed JavaScript files during development and use compressed ones on the live site. You can do so using the following check in your template:

{% if debug %}
    <script src="/js/script.js"></script>
{% else %}
    <script src="/js/script.min.js"></script>
{% endif %}

base_url, disqus_shortname and author are set in the default configuaration, where you can set arbitrary attributes that will be available in templates. These values will be overwritten though, when used as document attributes, which may or may not be what you want, so keep that in mind.

noindex has a special meaning to Logya. If you set it to a true value in a document header, that document will not appear in any of the document collections, including sitemaps and RSS feeds. The HTML page for that content will be created though, so you can use this for drafts that can be accessed but will not be automatically linked.


You can create a document collection to be included in the index from one or more header attributes by adding a setting for it in the site config and specifying a list of values in the doc header.

For example add an attribute called tags and assign it a list of comma separated values:

tags: [example tag 1, example tag 2, example tag 3]

If you specify document tags the tags sub-directory will be added to the document index, containing links to the corresponding documents. If you do this, don’t create document URLs that start with /tags/, the same applies to other user-defined index headers.

To create a list of links to these index pages from a post you can access the tags_links template variable, which is populated automatically and mustn’t be specified manually in the document header:

{% if tags_links %}
  {% for url, anchor in tags_links %}
    <span class="tag"><a href="{{url|e}}">{{anchor|e}}</a></span>
  {% endfor %}
{% endif %}

Alternatively you can use the provided collection macro as follows:

{% import 'macros/links.html' as links %}
<p>Tags: {{ links.collection(tags_links) }}</p>

Since this template variable is generated from the corresponding attribute name, only use letters and underscores in it. An index collection can be created for header attributes that contain a list of string values.

Document Body

The remaining part of the document is treated as the content that goes in the body of the created HTML page. This content can either be written in markdown or marked up with any HTML tag that can be in the body of an HTML document. The body format is indicated by the file name extension.


<h1>This is a heading</h1>
<p>This is a paragraph</p>


# This is a heading

This is a paragraph