Skip to content

Latest commit

 

History

History
169 lines (108 loc) · 4.07 KB

README.md

File metadata and controls

169 lines (108 loc) · 4.07 KB
Raw

Earmark—A Pure Elixir Markdown Processor

Build Status Hex.pm

Dependency

{ :earmark, "> x.y.z" }

Usage

API

  html_doc = Earmark.to_html(markdown)

  html_doc = Earmark.to_html(markdown, options)

(See the documentation for to_html for options)

Command line

$ mix escript.build
$ ./earmark file.md

Supports

Standard Gruber markdown.

Extensions

Tables

Github Flavored Markdown tables are supported

    State | Abbrev | Capital
    ----: | :----: | -------
    Texas | TX     | Austin
    Maine | MN     | Augusta

Tables may have leading and trailing vertical bars on each line

    | State | Abbrev | Capital |
    | ----: | :----: | ------- |
    | Texas | TX     | Austin  |
    | Maine | MN     | Augusta |

Tables need not have headers, in which case all column alignments default to left.

    | Texas | TX     | Austin  |
    | Maine | MN     | Augusta |

Currently we assume there are always spaces around interior vertical bars. It isn't clear what the expectation is.

Adding HTML attributes

HTML attributes can be added to any block-level element. We use the Kramdown syntax: add the line {: attrs } following the block.

attrs can be one or more of:

  • .className
  • #id
  • name=value, name="value", or name='value'

For example:

    # Warning
    {: .red}

    Do not turn off the engine
    if you are at altitude.
    {: .boxed #warning spellcheck="true"}

Limitations

  • Nested block-level HTML is correctly handled only if each HTML tag appears on its own line. So

      <div>
  <div>
  hello
  </div>
  </div>

    will work. However. the following won't

      <div><div>
  hello
  </div></div>

  • John Gruber's tests contain an ambiguity when it comes to lines that might be the start of a list inside paragraphs.

    One test says that

      This is the text
  * of a paragraph
  that I wrote

    is a single paragraph. The "*" is not significant. However, another test has

      *   A list item
      * an another

    and expects this to be a nested list. But, in reality, the second could just be the continuation of a paragraph.

    I've chosen always to use the second interpretation—a line that looks like a list item will always be a list item.

Security

Please be aware that Markdown is not a secure format. It produces HTML from Markdown and HTML. It is your job to sanitize and or filter the output of Markdown.html if you cannot trust the input and are to serve the produced HTML on the Web.

Author

Copyright © 2014 Dave Thomas, The Pragmatic Programmers @/+pragdave, dave@pragprog.com

Licensed under the same terms as Elixir, which is Apache 2.0.

Details

Given a markdown document (as either a list of lines or a string containing newlines), return an HTML representation.

The options are a %Earmark.Options{} structure:

  • renderer: ModuleName

    The module used to render the final document. Defaults to Earmark.HtmlRenderer

  • gfm: boolean

    True by default. Turns on Github Flavored Markdown extensions

  • breaks: boolean

    Only applicable if gfm is enabled. Makes all line breaks significant (so every line in the input is a new line in the output.

  • smartypants: boolean

    Turns on smartypants processing, so quotes become curly, two or three hyphens become en and em dashes, and so on. True by default.

So, to format the document in original and disable smartypants, you'd call

alias Earmark.Options
result = Earmark.to_html(original, %Options{smartypants: false})

LICENSE

Same as Elixir, which is Apache License v2.0. Please refer to LICENSE for details.