github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #596 from tpievila/doc_fix

Browse source 
Metadata parity for RST/MD, document summary.
This commit is contained in:
Bruno Binet 2012-11-24 03:41:01 -08:00
commit 0fbf96b4be
1 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/getting_started.rst
View file

@ -153,7 +153,9 @@ following syntax (give your file the ``.rst`` extension)::
:date: 2010-10-03 10:20 :date: 2010-10-03 10:20
:tags: thats, awesome :tags: thats, awesome
:category: yeah :category: yeah
:slug: my-super-post
:author: Alexis Metaireau :author: Alexis Metaireau
:summary: Short version for index and feeds
Pelican implements an extension of reStructuredText to enable support for the Pelican implements an extension of reStructuredText to enable support for the
``abbr`` HTML tag. To use it, write something like this in your post:: ``abbr`` HTML tag. To use it, write something like this in your post::
@ -165,10 +167,13 @@ Markdown generation will not work until you explicitly install the ``Markdown``
package, which can be done via ``pip install Markdown``. Metadata syntax for package, which can be done via ``pip install Markdown``. Metadata syntax for
Markdown posts should follow this pattern:: Markdown posts should follow this pattern::
Date: 2010-12-03
Title: My super title Title: My super title
Date: 2010-12-03 10:20
Tags: thats, awesome Tags: thats, awesome
Category: yeah
Slug: my-super-post Slug: my-super-post
Author: Alexis Metaireau
Summary: Short version for index and feeds
This is the content of my super blog post. This is the content of my super blog post.
@ -178,7 +183,9 @@ category can be determined by the directory in which the file resides. For
example, a file located at ``python/foobar/myfoobar.rst`` will have a category of example, a file located at ``python/foobar/myfoobar.rst`` will have a category of
``foobar``. If you would like to organize your files in other ways where the ``foobar``. If you would like to organize your files in other ways where the
name of the subfolder would not be a good category name, you can set the name of the subfolder would not be a good category name, you can set the
setting ``USE_FOLDER_AS_CATEGORY`` to ``False``. setting ``USE_FOLDER_AS_CATEGORY`` to ``False``. If summary isn't given, setting
``SUMMARY_MAX_LENGTH`` determines how many words from the beginning of an article
are used as the summary.
Generate your blog Generate your blog
------------------ ------------------