ex_doc_simple_markdown v0.5.1 ExDocSimpleMarkdown

A SimpleMarkdown processor for ExDoc.

Provides configurable options for the assets (:assets), before_closing_head_tag (:head_tag), before_closing_body_tag (:body_tag) behaviours defined by ExDoc (when using a version earlier than v0.21.0). As well as the option to enable or disable pretty codeblocks (:pretty_codeblocks), manipulate the rules (:rules), change the renderer (:renderer), and specify modules that implement the extensions behaviour (:extensions).

config :ex_doc_simple_markdown, [
        assets: [{ "dist/hello-js.js", "alert('hello');" }], # Has no effect in ExDoc v0.21.0 and later
        head_tag: "<script src=\"dist/hello-js.js\"></script>", # Has no effect in ExDoc v0.21.0 and later
        body_tag: "<script>alert('goodbye');</script>", # Has no effect in ExDoc v0.21.0 and later
        pretty_codeblocks: false, # Has no effect in Exdoc v0.25.0 and later
        rules: fn rules ->
            # Manipulate the rules
            rules
        end,
        renderer: &MyHTMLRenderer.render/1,
        extensions: [
            MyCustomExtension
        ]
    ]

Extensions can optionally be passed to the :markdown_processor_options option in ex_doc.

Link to this section Summary

Link to this section Functions

Link to this function

before_closing_body_tag(_)

Link to this function

before_closing_head_tag(_)

Link to this function

configure(config)

Link to this function

to_html(input, opts)