f1x1t/pelican-md-metayaml
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added dependencies to README

Browse Source
This commit is contained in:
Joachim Neu 2014-11-02 02:38:41 +01:00
parent 22712fc787
commit 835dadbd81
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -5,11 +5,18 @@ This [Pelican](https://github.com/getpelican/pelican) plugin adds a reader for M
As the well-known static site generator [Jekyll](https://github.com/jekyll/jekyll) uses Markdown files with YAML metadata, this eases migration from Jekyll to Pelican. As the well-known static site generator [Jekyll](https://github.com/jekyll/jekyll) uses Markdown files with YAML metadata, this eases migration from Jekyll to Pelican.
Also, YAML metadata allows for easier specification of more complex metadata, such as nested lists or dictionaries. Also, YAML metadata allows for easier specification of more complex metadata, such as nested lists or dictionaries.
Dependencies
------------
(to be installed via `pip`)
* `Markdown`
* `PyYAML`
Installation Installation
------------ ------------
Copy the `md_yaml` directory to the `plugins` directory of your Pelican project (or whatever directory you specified for plugins in Pelican's `PLUGIN_PATHS` setting) and add Copy the `md_yaml` directory to the `plugins` directory of your Pelican project (or whatever directory you specified for plugins in Pelican's `PLUGIN_PATHS` setting) and add `'md_yaml'` to the list of plugins (Pelican setting `PLUGINS`) of your project.
`'md_yaml'` to the list of plugins (Pelican setting `PLUGINS`) of your project.
Usage Usage
----- -----