markdown-to-html

markdown-to-html
================

Command-line utility to convert Github Flavored Markdown to HTML.
Output may be to stdout or to your default browser.
Also, the underlying Markdown and GithubMarkdown classes are readable stream classes
and may be used however you like (e.g., pipe to an http response or to stdout).
Includes a demo of a web server app that uses both the classes.

##Installation

####To use the command line utilities

``
npm install markdown-to-html -g
`

####To use the Markdown or GithubMarkdown classes in your project

npm install markdown-to-html --save

##Example Usage

####Command line utility to output HTML to stdout

markdown myfile.md []

####Command line utility to output HTML to default browser

markdownb myfile.md []

####Command line utility to output the Github API results to stdout


github-markdown myfile.md []

####Command line utility to output the Github API results to default browser

github-markdownb myfile.md []

####Run the web demo

1. Run git clone https://github.com/cwjohan/markdown-to-html.git to create a markdown-to-html directory.
1. Run cd markdown-to-html
1. Run npm install
1. Run npm start.
1. In a web browser address field type localhost:3000.

###Use the Markdown class to render markdown text

`js
var Markdown = require('markdown-to-html').Markdown;
var md = new Markdown();
md.bufmax = 2048;
var fileName = 'test/test.md';
var opts = {title: 'File $BASENAME in $DIRNAME', stylesheet: 'test/style.css'};
...
// Write a header.
console.log('===============================');
// Write a trailer at eof.
md.once('end', function() {
console.log('===============================');
});
md.render(fileName, opts, function(err) {
if (err) {
console.error('>>>' + err);
process.exit();
}
md.pipe(process.stdout);
});
`

##Options for markdown and markdownb

####--flavor

Format as type 'gfm' or just plain 'markdown'. May be abbreviated -f on the command line.
Note that for the github-markdown utility or the GithubMarkdown class it is the 'markdown' flavor that gives you
something resembling the README.md format on Github. Whereas, the 'gfm' flavor gives you something resembling the
the format of comments and issues on Github. This is due to how the Github Markdown API works. On the other hand,
for the markdown utility or the Markdown class it is virtually the opposite. For example, fenced code blocks
don't work when using the markdown utility or the Markdown class with the --flavor markdown option. This is
due to how the marked markdown parser works. The default value for this option is whichever flavor results in
something more like README.md format.

####--highlight

Highlight code blocks with style info. Highlight has no effect in github-markdown.
May be abbreviated -h on the command line. Defaults to false.

####--stylesheet

Outputs HTML header with link element referring to the given stylesheet.
May be abbreviated -s on the command line.

####--title