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

the dep to markdown is optional. rst is not.

Browse source
This commit is contained in:
Alexis Metaireau 2012-04-01 14:46:09 +02:00
commit 9f03a407cb
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/getting_started.rst
View file

@ -22,13 +22,13 @@ At this time, Pelican is dependent on the following Python packages:
* feedgenerator, to generate the Atom feeds * feedgenerator, to generate the Atom feeds
* jinja2, for templating support * jinja2, for templating support
* docutils, for supporting reStructuredText as an input format
If you're not using Python 2.7, you will also need `argparse`. If you're not using Python 2.7, you will also need `argparse`.
Optionally: Optionally:
* pygments, for syntax highlighting * pygments, for syntax highlighting
* docutils, for supporting reStructuredText as an input format
* Markdown, for supporting Markdown as an input format * Markdown, for supporting Markdown as an input format
Writing articles using Pelican Writing articles using Pelican
@ -53,7 +53,11 @@ following syntax (give your file the `.rst` extension)::
:author: Alexis Metaireau :author: Alexis Metaireau
You can also use Markdown syntax (with a file ending in `.md`):: You can also use Markdown syntax (with a file ending in `.md`).
Markdown generation will not work until you explicitly install the `markdown`
distribution. You can do so on a normal system using `pip install markdown`
::
Date: 2010-12-03 Date: 2010-12-03
Title: My super title Title: My super title