From 4743678bc91f2e5ad363f1e9eff94751718f0f5c Mon Sep 17 00:00:00 2001 From: Alexis Metaireau Date: Sun, 31 Oct 2010 01:15:35 +0000 Subject: [PATCH] Update the readme with markdown. --- README.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ecf0b33b..b767145f 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,7 @@ Pelican Pelican is a simple weblog generator, writen in python. * 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. * Easy to interface with DVCSes and web hooks * Completely static output, so easy to host anywhere ! @@ -27,6 +27,14 @@ following syntax:: :category: yeah :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 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`.