From 008f240a8cd3c08f25f11352539c6b7031dd3c5f Mon Sep 17 00:00:00 2001 From: pR0Ps Date: Thu, 25 Dec 2014 00:41:29 -0500 Subject: [PATCH] Update README --- README.md | 63 ++++++++++++++++++++----------------------------------- 1 file changed, 23 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 36ce202..5bb9f7a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -pelican-md-yaml -=============== +pelican-md-metayaml +=================== This [Pelican](https://github.com/getpelican/pelican) plugin adds a reader for Markdown files with [YAML](https://en.wikipedia.org/wiki/YAML) metadata. 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. @@ -16,54 +16,37 @@ Dependencies 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 `'md_yaml'` to the list of plugins (Pelican setting `PLUGINS`) of your project. +Clone this repo (and it's submodules) to the `plugins` directory of your Pelican project (or whatever directory you specified for plugins in Pelican's `PLUGIN_PATHS` setting) and add `'md_metayaml'` to the list of plugins (Pelican setting `PLUGINS`) of your project. + +To make sure the submodule is included use `git clone --recursive [repo] [path]` +Alternatively, you can clone normally, then run `git submodule update --init` to checkout the submodule Usage ----- All your Markdown files (ending in `.md`, `.markdown`, `.mkd` and `.mdown`) will now be interpreted as using YAML for their metadata. + The following example shows a very simple article (only one line of text at the bottom) but with quite complex metadata (everything between the `---`): ``` --- -template: article_recipe -title: Tiramisù -components: - - name: Tiramisù - for: 10 - ingredients: - - - 4 - - eggs - - - 150g - - sugar - - - 10 small cups - - espresso - - - 500g - - mascarpone - - - 1 package - - ladyfingers +title: Some title +author: Some person +tags: + - tag 1 + - tag 2 +date: 2014-12-25 00:00 +data: + - name: some name + options: + - opt 1 + - opt 2 + - opt 3 steps: - - Cook the espresso, pour it into a soup plate. - - Separate the eggs very carefully. - - Add very little salt to the egg white. - - Blend egg yolk and sugar and mix it extensively for some minutes using a mixer, until you obtain a homogenous mass. - - Add mascarpone and mix again very extensively. - - Beat the egg white and fold it into the other mass. - - Construct the tiramisù: First a layer of cream, then a layer of ladyfingers dipped into espresso, cream, ladyfingers, ..., cream. Sprinkle with cacao. - - Put the tiramisù into the fridge for about a night, serve cold! + - Step 1 + - Step 2 + - Step 3 --- -Thank you Silvia for the recipe! +This is the only text in the article. ``` - -Warranty --------- - -No warranty whatsoever is provided for either the code or the recipe provided above! ;) Use only at your own risk! - -References ----------- - -* This Pelican plugin uses the Markdown extension `mdx_meta_yaml` found here: -* The Pelican plugin `markdown-pullquote` was used as an example for a Pelican plugin providing a Markdown extension and can be found here: -* A similar approach to YAML metadata in Markdown files can be found here: