Repository files navigation

Hoedown is a revived fork ofSundown,the Markdown parser based on the original code of theUpskirt libraryby Natacha Porté.

• Fully standards compliant

  Hoedown passes out of the box the official Markdown v1.0.0 and v1.0.3test suites, and has been extensively tested with additional corner casesto make sure its output is as sane as possible at all times.

• Massive extension support

  Hoedown has optional support for several (unofficial) Markdown extensions,such as non-strict emphasis, fenced code blocks, tables, autolinks,strikethrough and more.

• UTF-8 aware

  Hoedown is fully UTF-8 aware, both when parsing the source document and whengenerating the resulting (X)HTML code.

• Tested & Ready to be used on production

  Hoedown has been extensively security audited, and includes protection againstall possible DOS attacks (stack overflows, out of memory situations, malformedMarkdown syntax...).

  We've worked very hard to makeHoedown never leak or crash underany input.

  Warning:Hoedown doesn't validate or post-process the HTML in Markdown documents.Unless you useHTML_ESCAPE orHTML_SKIP, you should strongly consider using agood post-processor in conjunction with Hoedown to prevent client-side attacks.

• Customizable renderers

  Hoedown is not stuck with XHTML output: the Markdown parser of the libraryis decoupled from the renderer, so it's trivial to extend the library withcustom renderers. A fully functional (X)HTML renderer is included.

• Optimized for speed

  Hoedown is written in C, with a special emphasis on performance. When wrappedon a dynamic language such as Python or Ruby, it has shown to be up to 40times faster than other native alternatives.

• Zero-dependency

  Hoedown is a zero-dependency library composed of some.c files and theirheaders. No dependencies, no bullshit. Only standard C99 that builds everywhere.

• Additional features

  Hoedown comes with a fully functional implementation of SmartyPants,a separate autolinker, escaping utilities, buffers and stacks.

You can see a community-maintained list ofHoedown bindings atthe wiki. There is also amigration guideavailable for authors of Sundown bindings.

Hoedown is all about security. If you find a (potential) security vulnerability in thelibrary, or a way to make it crash through malicious input, please report it to us byemailing the privateHoedown Securitymailing list. TheHoedown security team will review the vulnerability and work with youto reproduce and resolve it.

Given that the Markdown spec makes no provision for Unicode character handling,Hoedowntakes a conservative approach towards deciding which extended characters trigger Markdownfeatures:

• Punctuation characters outside of the U+007F codepoint are not handled as punctuation.They are considered as normal, in-word characters for word-boundary checks.

• Whitespace characters outside of the U+007F codepoint are not considered aswhitespace. They are considered as normal, in-word characters for word-boundary checks.

Just typingmake will buildHoedown into a dynamic library and create thehoedownandsmartypants executables, which are command-line tools to render Markdown to HTMLand perform SmartyPants, respectively.

If you are usingCocoaPods, just add the linepod 'hoedown' to your Podfile and callpod install.

Or, if you prefer, you can just throw the files atsrc into your project.