render-readme
render and sanitize readme.md just like github would
Last updated 11 years ago
by rlidwka
.
MIT
·
Repository
·
Bugs
·
Original npm
·
Tarball
·
package.json
$ cnpm install render-readme
SYNC missed versions from
official npm registry.
Render and sanitize readme.md just like github would.
Basically, it's node.js version for this: https://github.com/github/markup
But only for markdown for now, because that's what io.js packages use mostly.
API
require('render-readme')('Hello, *world*!')
// outputs '<p>Hello, <em>world</em>!</p>\n'
Features
- the basic rendering is commonmark + gfm extensions (emphasis slightly differs, but nobody cares anyway)
- html is sanitized, the configuration is similar to github stuff (using sanitize-html)
- syntax highlighting (using highlight-js for this one)
- YAML metadata on top of markdown documents is rendered to a table
- anchors for headers (
<a name="blah">instead of<a id="user-content-blah">, but should be good enough)
Current Tags
- 1.3.1 ... latest (11 years ago)
10 Versions
Maintainers (1)
Downloads
Today
0
This Week
0
This Month
0
Last Day
0
Last Week
0
Last Month
1
Dependencies (4)
- markdown-it 4.x
- sanitize-html 1.x >=1.4
- js-yaml 3.x >=3.2
- highlight.js 8.x
Dev Dependencies (0)
None
Dependents (1)