Skip to content

Commit

Permalink
Document the remainder of the blog extension.
Browse files Browse the repository at this point in the history
  • Loading branch information
mblayman committed Jul 17, 2015
1 parent ed900a2 commit 3cb5132
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ It can also create an entry list for one of your pages.
Enable the blog extension by adding ``with_blog = True`` to
the ``site`` section of your configuration file.

Atom feed
~~~~~~~~~

The extension requires some additional information
to create a valid atom feed.
Add a ``blog`` section to your configruation file
Expand All @@ -73,6 +76,9 @@ In this example, the atom feed would be stored
in the root of the output directory
with a filename of ``feed.xml``.

List page
~~~~~~~~~

To create a blog list page,
add a ``list_template`` option to your ``blog`` section.
If you include ``list_template``,
Expand Down Expand Up @@ -108,3 +114,21 @@ And here is some possible output.
</ul>
</body>
</html>

Blog post frontmatter
~~~~~~~~~~~~~~~~~~~~~

A source file is marked as a blog post by setting ``blog: True``
in the front matter.
The blog front matter has required and optional fields.

Required fields:

* ``title`` - The title of the post
* ``date`` - The published date of the post.
The date should be in RfC 3339 format
(e.g., ``2015-07-15T12:00:00Z``).

Optional fields:

* ``summary`` - A summary of the post.

0 comments on commit 3cb5132

Please sign in to comment.