makedown v0.1.0 Makedown.ExDoc View Source

A markdown implementation compatible with ExDoc

To use, follow these steps:

Make ExDocs use Makedown for markdown rendering

For that, add the following line to your app’s config.exs file:

config :ex_doc, :markdown_processor, Makedown.ExDoc

Generate the Makedown assets.

Run the following mix task:

mix makedown.ex_doc.assets

Configure ExDocs to use the assets

After generating the assets, edit your project’s :docs configuration options so that it uses the assets we’ve generated.

Just add the following lines to the :docs config option in your MixFile:

def project do
  [
    ...
    docs: [
      # This is the location where the mix task will place the assets
      assets: "priv/doc/assets",
      # Extra CSS
      before_closing_head_tag: ~S(<link rel="stylesheet" href="assets/makedown.css" />),
      # Extra Javascript
      before_closing_body_tag: ~S(<script src="assets/makedown.js"></script>)
    ]
  ]
end