Snarkdown

Snarkdown

Snarkdown is a dead simple **1kb** [Markdown] parser. It's designed to be as minimal as possible, for constrained use-cases where a full Markdown parser would be inappropriate. ## Features - **Fast:** since it's basically one regex and a huge if statement - **Tiny:** it's 1kb of gzipped ES3 - **Simple:** pass a Markdown string, get back an HTML string > **Note:** Tables are not yet supported. If you love impossible to read regular expressions, submit a PR! > > **Note on XSS:** Snarkdown [doesn't sanitize HTML](https://github.com/developit/snarkdown/issues/70), since its primary target usage doesn't require it. ## Demos & Examples - ⚛️ [**Snarky**](https://snarky.surge.sh) - markdown editor built with Preact & Snarkdown - ✏️ [**Simple Markdown Editor**](http://jsfiddle.net/developit/828w6t1x/) ## Usage Snarkdown exports a single function, which parses a string of Markdown and returns a String of HTML. Couldn't be simpler. The snarkdown module is available in [every module format](https://unpkg.com/snarkdown/dist/) you'd ever need: ES Modules, CommonJS, UMD... ```js import snarkdown from 'snarkdown'; let md = '_this_ is **easy** to `use`.'; let html = snarkdown(md); console.log(html); // this is easy to use. ``` ### Add-ons and Libraries - For Webpack users, [`snarkdown-loader`](https://github.com/Plugin-contrib/snarkdown-loader) renders markdown files to html. [Markdown]: http://daringfireball.net/projects/markdown/

	Stars	Issues	Version	Updated	Created
markdown	7,693	104	0.5.0	11 years ago	13 years ago
marked	32,005	25	12.0.2	a month ago	13 years ago
remark			15.0.1	8 months ago	11 years ago
showdown	13,958	203	2.1.0	2 years ago	13 years ago
snarkdown	2,241	41	2.0.0	4 years ago	10 years ago
spectacle	9,680	71	10.1.8	2 months ago	9 years ago

markdown vs marked vs remark vs showdown vs snarkdown vs spectacle

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past