https://github.com/steveklabnik/metadown

Annotate your Markdown files with metadata.
https://github.com/steveklabnik/metadown

Last synced: 25 days ago
JSON representation

Annotate your Markdown files with metadata.

• Host: GitHub
• URL: https://github.com/steveklabnik/metadown
• Owner: steveklabnik
• License: mit
• Created: 2012-01-23T00:23:59.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2018-11-01T04:31:52.000Z (about 6 years ago)
• Last Synced: 2024-11-27T17:50:05.071Z (about 1 month ago)
• Language: Ruby
• Homepage: http://rubydoc.info/github/steveklabnik/metadown/master/file/README.md
• Size: 116 KB
• Stars: 69
• Watchers: 3
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Metadown

[![Build Status](https://secure.travis-ci.org/steveklabnik/metadown.png)](http://travis-ci.org/steveklabnik/metadown)

tl;dr... This gem gives you a custom markdown parser that allows you to prefix the

markdown itself with YAML metadata.

Sometimes, just having plain markdown isn't good enough. Say you're writing

a blog post, and you want to include some information about the post itself,

such as the date and time it was posted.  Keeping it in a separate file seems

like a bad idea, but Markdown doesn't have any good way of doing this.

Enter [Jekyll](https://github.com/mojombo/jekyll). It lets you put some YAML

at the head of your file:

    ---

    layout: post

    title: An Awesome Blog Post

    ---

    

    Four score and seven years ago,

Woudn't that be neat to use on other projects? I thought so too! Hence,

metadown.

Furthermore, you don't have to have just markdown. Inject any kind of

parser you'd like!

## Installation

Add this line to your application's Gemfile:

    gem 'metadown'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install metadown

## Usage

Metadown might have the simplest API I've ever written: one method! Just send

the string with the metadown you want rendered, and boom! You get an object

back with two attributes: output and metadata.

    require 'metadown'

    

    data = Metadown.render("hello world")

    data.output #=> "
hello, world
"

    data.metadata #=> "{}"

    

    text = <<-MARKDOWN

    ---

    key: "value"

    ---

    hello world

    MARKDOWN

    

    data = Metadown.render(text)

    data.output #=> "
hello, world
\n"

    data.metadata #=> {"key" => "value"}


The default Markdown parser Metadown uses is pretty simple. If you'd

like to change it, you can inject your own in the standard Redcarpet 

fashion. Here's an example with code highlighting using Pygments.

```ruby

class HTMLwithPygments < Metadown::Renderer

  def block_code(code, language)

    Pygments.highlight(code, :lexer => language)

  end

end

```

Then use it with Metadown like this:

```ruby

require 'metadown'

require 'html_with_pygments'

renderer = Redcarpet::Markdown.new(HTMLwithPygments, :fenced_code_blocks => true)

data = Metadown.render("```ruby\nself\n```", renderer)

data.output   #=> "


self\n
\n
\n"

data.metadata #=> "{}"

```


The Redcarpet [README](https://github.com/vmg/redcarpet/blob/master/README.markdown)

has more examples on how to customize your Markdown rendering.

    

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Added some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request