Tiny Slack-style markdown renderer for Node and browser, with CLI.
npm i -S zeedown
or yarn add zeedown
zeedown(text: string): string
zeedown
takes one parameters: a required string.
Difference from standard MD:
- 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.
import md from 'zeedown'
// or
const md = require('zeedown')
md('some string')
md(process.argv[2])
$('.foo').replaceWith(md($('.bar').text()))
zeedown
comes with a small CLI. Usage:
cat foo.md | zeedown > foo.html
- Strong (Bold)
- Emphasis (Italic)
- Deletions (Strikethrough)
- Inline code
- Fenced code blocks (not indent)
- Blockquotes
- Ordered/unordered lists
If you want links, images, syntax highlighting, and other fancy stuff,
you're probably better off using a full-featured implementation. Try marked
,
it's super popular.
Everything specified works. ol
, ul
, and blockquote
are a little funky
(only work if not indented at all, need an extra pass to strip extra tags).