wbrawner/hoedown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Standards compliant, fast, secure markdown processing library in C
403 commits 3 branches 12 tags 1 MiB
C 72.3%
HTML 23.7%
Perl 1.7%
Python 1.4%
Makefile 0.9%
Find a file
Xavier Mendez f62c5a79bb Remove wrong grow()s in escape 
They assume the buffer is empty, which is wrong.

Even if they took that into account, these small grows
are useless most of the time (the unit is big).
2014-04-09 13:18:07 +02:00
bin Remove useless HTML_TOC flag 2014-03-29 14:10:08 +01:00
src Remove wrong grow()s in escape 2014-04-09 13:18:07 +02:00
test Set permissions of named pipes created by the test runner to 0600 2014-01-24 00:24:10 +00:00
.editorconfig Add .editorconfig 2013-09-20 19:08:28 -05:00
.gitignore Fix building with MingW and MSVC 2013-09-22 04:10:51 -05:00
.travis.yml Install tidy before running tests 2013-09-20 19:50:05 -05:00
hoedown.def api_v3: document: actually rename the API 2014-02-06 20:16:23 +01:00
html_block_names.gperf Improvements to the gperf flow 2013-09-20 21:57:08 -05:00
LICENSE Spread ❤️ even on the LICENSE! 2013-09-20 21:07:07 +02:00
Makefile Rename examples/ to bin/ 2014-03-23 20:17:02 +01:00
Makefile.win Rename examples/ to bin/ 2014-03-23 20:17:02 +01:00
README.md README: Remove incorrect statement 2014-03-29 14:17:24 +01:00

README.md

Hoedown

Build Status

Hoedown is a revived fork of Sundown, the Markdown parser based on the original code of the Upskirt library by Natacha Porté.

Features

  • Fully standards compliant

    Hoedown passes out of the box the official Markdown v1.0.0 and v1.0.3 test suites, and has been extensively tested with additional corner cases to 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 when generating the resulting (X)HTML code.

  • Tested & Ready to be used on production

    Hoedown has been extensively security audited, and includes protection against all possible DOS attacks (stack overflows, out of memory situations, malformed Markdown syntax...) and against client attacks through malicious embedded HTML.

    We've worked very hard to make Hoedown never leak or crash under any input.

  • Customizable renderers

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

  • Optimized for speed

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

  • Zero-dependency

    Hoedown is a zero-dependency library composed of some .c files and their headers. 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.

Bindings

You can see a community-maintained list of Hoedown bindings at the wiki. There is also a migration guide available for authors of Sundown bindings.

Help us

Hoedown is all about security. If you find a (potential) security vulnerability in the library, or a way to make it crash through malicious input, please report it to us by emailing the private Hoedown Security mailing list. The Hoedown security team will review the vulnerability and work with you to reproduce and resolve it.

Unicode character handling

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

  • 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 as whitespace. They are considered as normal, in-word characters for word-boundary checks.

Install

Just typing make will build Hoedown into a dynamic library and create the hoedown and smartypants executables, which are command-line tools to render Markdown to HTML and perform SmartyPants, respectively.

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