Skip to content

Add plugins support to Earmark processor #838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2018
Merged

Add plugins support to Earmark processor #838

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion lib/ex_doc/markdown/earmark.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ defmodule ExDoc.Markdown.Earmark do
* `: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

* `:plugins` - map of strings to modules. Register custom plugins to be used with
Earmark. See [Plugins](http://github.com/pragdave/earmark#plugins) for details on
how to write custom plugins.

"""
def to_html(text, opts) do
options =
Expand All @@ -40,7 +44,8 @@ defmodule ExDoc.Markdown.Earmark do
line: Keyword.get(opts, :line, 1),
file: Keyword.get(opts, :file),
breaks: Keyword.get(opts, :breaks, false),
smartypants: Keyword.get(opts, :smartypants, true))
smartypants: Keyword.get(opts, :smartypants, true),
plugins: Keyword.get(opts, :plugins, %{}))
text |> Earmark.as_html!(options) |> ExDoc.Markdown.pretty_codeblocks()
end
end