[
    {
        "name": "Markdown",
        "comment": "A library for markdown parsing. This is just an Elm API built on top of the\n[marked](https://github.com/chjj/marked) project which focuses on speed.\n\n# Parsing Markdown\n@docs toElement, toHtml\n\n# Parsing with Custom Options\n@docs Options, defaultOptions, toElementWith, toHtmlWith",
        "unions": [],
        "aliases": [
            {
                "name": "Options",
                "comment": "Some parser options so you can tweak things for your particular case.\n\n  * `githubFlavored` — overall reasonable improvements on the original\n    markdown parser as described [here][gfm]. This includes stuff like [fenced\n    code blocks][fenced]. There are some odd parts though, such as [tables][]\n    and a setting to turn all newlines into newlines in the resulting output,\n    so there are settings to turn those on or off based on your preference.\n\n  * `sanitize` — this determines if all HTML should be escaped. If you\n    are parsing user markdown or user input can somehow reach the markdown\n    parser, you should almost certainly turn on sanitation. If it is just you\n    writing markdown, turning sanitation off is a nice way to do some HTML\n    tricks if it is needed.\n\n  * `smartypants` — This will automatically upgrade quotes to the\n    prettier versions and turn dashes into [em dashes or en dashes][dash]\n\n\n[gfm]: https://help.github.com/articles/github-flavored-markdown/\n[fenced]: https://help.github.com/articles/github-flavored-markdown/#fenced-code-blocks\n[tables]: https://help.github.com/articles/github-flavored-markdown/#tables\n[dash]: http://en.wikipedia.org/wiki/Dash",
                "args": [],
                "type": "{ githubFlavored : Maybe { tables : Bool, breaks : Bool }, sanitize : Bool, smartypants : Bool }"
            }
        ],
        "values": [
            {
                "name": "defaultOptions",
                "comment": "The `Options` used by the `toElement` and `toHtml` functions.\n\n    { githubFlavored = Just { tables = False, breaks = False }\n    , sanitize = False\n    , smartypants = False\n    }",
                "type": "Options"
            },
            {
                "name": "toElement",
                "comment": "Turn a markdown string into an HTML element, using the `defaultOptions`.\n\n    intro : Element\n    intro =\n        Markdown.toElement \"\"\"\n\n    # Time Travel Made Easy\n\n    Elm Reactor grew out of my internship working on Elm at Prezi this summer...\n\n    \"\"\"",
                "type": "String -> Element"
            },
            {
                "name": "toElementWith",
                "comment": "Maybe you want to get prettier quotes with a simple syntax. You can use\nmodified parsing options.\n\n    options : Options\n    options =\n        { defaultOptions | smartypants <- True }\n\n    toSmartElement : String -> Element\n    toSmartElement markdown =\n        Markdown.toElementWith options markdown",
                "type": "Options -> String -> Element"
            },
            {
                "name": "toHtml",
                "comment": "Turn a markdown string into an HTML element, using the `defaultOptions`.\n\n    bodyParagraph : Html\n    bodyParagraph =\n        Markdown.toHtml \"\"\"\n\n    # Changing History\n\n    In addition to time travel, Elm Reactor lets you change history...\n\n    \"\"\"",
                "type": "String -> Html"
            },
            {
                "name": "toHtmlWith",
                "comment": "Maybe you want to parse user input into markdown. To stop them from adding\n`<script>` tags, you can use modified parsing options.\n\n    options : Options\n    options =\n        { defaultOptions | sanitize <- True }\n\n    toMarkdown : String -> Html\n    toMarkdown userInput =\n        Markdown.toHtmlWith options userInput",
                "type": "Options -> String -> Html"
            }
        ],
        "binops": []
    }
]