Skip to content
😼 A snarky 1kb Markdown parser written in JavaScript
JavaScript
Branch: master
Clone or download
developit Merge pull request #59 from developit/greenkeeper/mocha-5.1.1
Update mocha to the latest version 🚀
Latest commit b01a5cd May 28, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Patch for fenced code blocks Oct 1, 2017
test
.babelrc feat(tooling): Import tooling from unfetch Feb 25, 2017
.editorconfig Update packaging 🌈 Feb 26, 2017
.gitignore feat(tooling): Import tooling from unfetch Feb 25, 2017
.travis.yml travis fix Feb 26, 2017
LICENSE Update packaging 🌈 Feb 26, 2017
README.md remove CodeSponsor, see https://codesponsor.io/shutdown-notice/ Dec 3, 2017
package.json chore(package): update mocha to version 5.1.1 Apr 19, 2018

README.md

Snarkdown
npm travis

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!

Demos & Examples

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 you'd ever need: ES Modules, CommonJS, UMD...

import snarkdown from 'snarkdown';

let md = '_this_ is **easy** to `use`.';
let html = snarkdown(md);
console.log(html);
// <em>this</em> is <strong>easy</strong> to <code>use</code>.

License

MIT

You can’t perform that action at this time.