Writing content

Yozuch posts and documents are written in reStructuredText format.

Document example:

Documents title
===============

Hello, world!

:tags: blog, demo

You can learn more about reStructuredText syntax at Sphinx documentation or at official reStructuredText website.

Meta data

File name meta

Yozuch tries to extract date and slug from the file name.

There are two supported formats by default: {date}-{slug}.rst and {slug}.rst. Default date format is %Y-%m-%d.

Examples:

  • 2014-01-30-first-post.rst

  • about.rst

reStructuredText meta

Name

Example

Description

date

2014-01-01

Date. You can change date format using RST_OPTIONS

tags

blog, python

Comma separated list of tags

Example:

:date: 2014-01-01
:tags: blog, python

Cross-referencing posts and documents

Posts and documents can link to each other using the following syntax: /posts/filename.rst or /documents/filename.rst.

`My first post </posts/2014-01-30-first-post.rst>`_.

`About page </documents/about.rst>`_.