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

Update the readme with markdown.

Browse source
This commit is contained in:
Alexis Metaireau 2010-10-31 01:15:35 +00:00
commit 4743678bc9
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.rst
View file

@ -4,7 +4,7 @@ Pelican
Pelican is a simple weblog generator, writen in python. Pelican is a simple weblog generator, writen in python.
* Write your weblog entries directly with your editor of choice (vim!) and * Write your weblog entries directly with your editor of choice (vim!) and
directly in restructured text. directly in restructured text, or markdown.
* A simple cli-tool to (re)generate the weblog. * A simple cli-tool to (re)generate the weblog.
* Easy to interface with DVCSes and web hooks * Easy to interface with DVCSes and web hooks
* Completely static output, so easy to host anywhere ! * Completely static output, so easy to host anywhere !
@ -27,6 +27,14 @@ following syntax::
:category: yeah :category: yeah
:author: Alexis Metaireau :author: Alexis Metaireau
You can also use a mardown syntax::
Date: 2010-12-03
Title: My super title
Put you content here.
Note that only the `date` metadata is mandatory, so you just have to add that in i Note that only the `date` metadata is mandatory, so you just have to add that in i
your files. The category can also be determined by the directory where the rst file your files. The category can also be determined by the directory where the rst file
is. For instance, the category of `python/foobar/myfoobar.rst` is `foobar`. is. For instance, the category of `python/foobar/myfoobar.rst` is `foobar`.