/markie

Toy markdown to HTML compiler Ruby gem

Primary LanguageRubyMIT LicenseMIT

Markie markie_logo

Proof-of-concept Markdown to HTML compiler Ruby gem. travis_build

markie_gem

Read about the theory behind markie: Entry-level Compiler

Quickstart

Add this line to your application's Gemfile:

gem 'markie'

And then install:

$ bundle install

Example

markdown = "[Markie](https://github.com/Thomascountz/markie) isn't _the_ best, but it's fun!"
=> "[Markie](https://github.com/Thomascountz/markie) isn't _the_ best, but it's fun!"

Markie.to_html(markdown)
=> "<body><p><a href=\"https://github.com/Thomascountz/markie\">Markie</a> isn't <em>the</em> best, but it's fun!</p></body>"

Follow the project's roadmap: Project Roadmap

Grammar v0.0.2

Body           := Paragraph*
Paragraph      := Sentence+ <EOF>
Sentence       := Text
                | Emphasis
                | Link
Text           := <TEXT>
Emphasis       := <UNDERSCORE> <TEXT> <UNDERSCORE>
                | <ASTERISK> <TEXT> <ASTERISK>
Link           := <OPEN_SQUARE_BRACKET> <TEXT> <CLOSED_SQUARE_BRACKET> <OPEN_PARENTHESIS> <TEXT> <CLOSED_PARENTHESIS>

Develop

Setup Markie for local development

$ bin/setup

Experiment with Markie

$ bin/console

markdown = "[Markie](https://github.com/Thomascountz/markie) isn't _the_ best, but it's fun!"
=> "[Markie](https://github.com/Thomascountz/markie) isn't _the_ best, but it's fun!"

Markie.to_html(markdown)
=> "<body><p><a href=\"https://github.com/Thomascountz/markie\">Markie</a> isn't <em>the</em> best, but it's fun!</p></body>"

Run tests

$ rake

Development Example v.0.0.2

markdown = "[Markie](https://github.com/Thomascountz/markie) isn't _the_ best, but it's fun!"
=> "[Markie](https://github.com/Thomascountz/markie) isn't _the_ best, but it's fun!"

tokens = Markie::Tokenizer.tokenize(markdown)
=> [#<Markie::Token:0x00007f942c095c00 @type=:open_square_bracket, @value="[">,
 #<Markie::Token:0x00007f942c115cc0 @type=:text, @value="Markie">,
 #<Markie::Token:0x00007f942c11c2f0 @type=:close_square_bracket, @value="]">,
 #<Markie::Token:0x00007f942c124400 @type=:open_parenthesis, @value="(">,
 #<Markie::Token:0x00007f942d0e7928 @type=:text, @value="https://github.com/Thomascountz/markie">,
 #<Markie::Token:0x00007f942d0e5f10 @type=:close_parenthesis, @value=")">,
 #<Markie::Token:0x00007f942d10d100 @type=:text, @value=" isn't ">,
 #<Markie::Token:0x00007f942d1171a0 @type=:underscore, @value="_">,
 #<Markie::Token:0x00007f942d12dc98 @type=:text, @value="the">,
 #<Markie::Token:0x00007f942d13f5b0 @type=:underscore, @value="_">,
 #<Markie::Token:0x00007f942d19f7f8 @type=:text, @value=" best, but it's fun!">,
 #<Markie::Token:0x00007f942d19f690 @type=:eof, @value="">]

ast = Markie::Parser.parse(tokens)
=> #<Markie::Node:0x00007f942d23a640
 @children=
  [#<Markie::Node:0x00007f942d23a708
    @children=
     [#<Markie::Node:0x00007f942d23aaf0 @children=[#<Markie::Node:0x00007f942d23abb8 @children=[], @token_count=1, @type=:text, @value="Markie">], @token_count=6, @type=:link, @value="https://github.com/Thomascountz/markie">,
      #<Markie::Node:0x00007f942d23aa00 @children=[], @token_count=1, @type=:text, @value=" isn't ">,
      #<Markie::Node:0x00007f942d23a910 @children=[], @token_count=3, @type=:emphasis, @value="the">,
      #<Markie::Node:0x00007f942d23a820 @children=[], @token_count=1, @type=:text, @value=" best, but it's fun!">],
    @token_count=11,
    @type=:paragraph,
    @value=nil>],
 @token_count=11,
 @type=:body,
 @value=nil>
 
 html = Markie::Generator.generate(ast)
 => "<body><p><a href=\"https://github.com/Thomascountz/markie\">Markie</a> isn't <em>the</em> best, but it's fun!</p></body>"

Abstract Syntax Tree as JSON

{
  "type": "body",
  "token_count": "11",
  "value": "",
  "children": [
    {
      "type": "paragraph",
      "token_count": "11",
      "value": "",
      "children": [
        {
          "type": "link",
          "token_count": "6",
          "value": "https://github.com/Thomascountz/markie",
          "children": [
            {
              "type": "text",
              "token_count": "1",
              "value": "Markie",
              "children": []
            }
          ]
        },
        {
          "type": "text",
          "token_count": "1",
          "value": " isn't ",
          "children": []
        },
        {
          "type": "emphasis",
          "token_count": "3",
          "value": "the",
          "children": []
        },
        {
          "type": "text",
          "token_count": "1",
          "value": " best, but it's fun!",
          "children": []
        }
      ]
    }
  ]
}