Tiny markdown renderer for Node and browser, with CLI.
npm i -S zeedown or
yarn add zeedown
zeedown(text: string, short: ?bool)
zeedown takes two parameters: a required string and an optional truthy value
short mode. In short mode:
- Strong is a single set of asterisks
- Emphasis is a single set of underscores
- Strikethrough is a single set of tildes
- No headers
This is essentially the same as Slack's basic Markdown.
// orconst md =
zeedown comes with a small CLI. Usage:
cat foo.md | zeedown > foo.html
It takes an optional flag
--short) to use
- Strong (Bold)
- Emphasis (Italic)
- Deletions (Strikethrough)
- Inline code
- Fenced code blocks (not indent)
- Ordered/unordered lists
Why Not Feature X?
If you want links, images, syntax highlighting, and other fancy stuff,
you're probably better off using a full-featured implementation. Try
it's super popular.
Everything specified works.
blockquote are a little funky
(only work if not indented at all, need an extra pass to strip extra tags).
A quick little benchmark has inconsistent results but it seems okay, and it's at lease a little better than it was when I started.