Skip to content

Commit

Permalink
Minor README changes, move author/license info
Browse files Browse the repository at this point in the history
  • Loading branch information
jmeosbn committed Sep 11, 2013
1 parent ff24277 commit 26f8ba7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 14 deletions.
30 changes: 18 additions & 12 deletions README.md
@@ -1,28 +1,23 @@
## MMD Meta

Created by Jamie Osborne, MIT License.

[Upstream GitHub project](https://github.com/jmeosbn/mmd_meta)


### Description

Support MultiMarkdown formatted metadata in Jekyll posts.


### Usage

Use MultiMarkdown style metadata in place of YAML frontmatter:
https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide
Use MultiMarkdown style [metadata] in place of YAML [frontmatter].

[metadata]: https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide
[frontmatter]: http://jekyllrb.com/docs/frontmatter/

Only supports Jekyll posts (as pages must start with `---`).
Only supports posts (Jekyll pages must start with `---`).

Converts MultiMarkdown keys to lowercase, e.g. 'Author' -> 'author'.


### Example

A post starting with:
A post starting with MultiMarkdown metadata:

Layout: post
Title: My Blog Post
Expand All @@ -31,7 +26,7 @@ A post starting with:

This is the post content

Will be read as if you had:
Will be read as if it had a YAML header:

---
layout: post
Expand All @@ -41,3 +36,14 @@ Will be read as if you had:
---

This is the post content


### Author

Created by [Jamie Osborne](https://github.com/jmeosbn).

[Upstream GitHub project](https://github.com/jmeosbn/mmd_meta)

### License

[MIT License](LICENSE).
4 changes: 2 additions & 2 deletions mmd_meta.rb
Expand Up @@ -7,8 +7,8 @@
# https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide
#
# Notes:
# Only supports Jekyll posts (as pages must start with `---`)
# Converts MultiMarkdown keys to lowercase, e.g. 'Author' -> 'author'
# Only supports posts (Jekyll pages must start with `---`).
# Converts MultiMarkdown keys to lowercase, e.g. 'Author' -> 'author'.
#
module Jekyll
module Convertible
Expand Down

0 comments on commit 26f8ba7

Please sign in to comment.