github-markdown-render

github-markdown-render

Render markdown using the GitHub Markdown API

Install

$ npm install --save github-markdown-render

Usage

const fs = require('fs');
const githubMarkdownRender = require('github-markdown-render');

githubMarkdownRender('**foo**').then(data => {
	console.log(data);
	//=> '<p><strong>foo</strong></p>'
});

fs.createReadStream('readme.md')
	.pipe(githubMarkdownRender.stream())
	.pipe(fs.createWriteStream('index.html'));

API

githubMarkdownRender(markdown)

Returns a promise with the rendered HTML.

markdown

Required
Type: string

Markdown to be rendered.

githubMarkdownRender.stream()

Creates a Readable/Writable stream which you can pipe markdown to.

CLI

$ npm install --global github-markdown-render

$ github-markdown-render --help

  Usage
    $ github-markdown-render **foo**
    $ cat readme.md | github-markdown-render

License

MIT Kevin Mårtensson