Mdex NPM | npm.io

mdex

Markdown in, github styled static docs out

Command line

Install globally for command line use:

$ npm install mdex -g

$ mdex src/mydoc.md output/mydoc.html

A static github styled HTML doc will be generated

Run locally

Install module locally

$ npm install mdex --save

var mdex = require('mdex.js');

mdex.generate('./tests/cheatsheet.md', './tests/output/cheatsheet.html', function(err, outputFile){

	if (err){
		throw err;
	}
	
	console.log('Successfully wrote to ' + outputFile);

});

Templating

You can specify a custom template to generate command by adding an arg:

$ mdex src/mydoc.md templates/custom.html output/mydoc.html

var mdex = require('mdex');

mdex.generate('./tests/cheatsheet.md', './tests/templates/narrow.html', './tests/output/cheatsheet.html', function(err, outputFile){

	if (err){
		throw err;
	}
	
	console.log('Successfully wrote to ' + outputFile);

});

Templates replace the following placeholder tags:

{{title}}
Autogenerated title will be inserted here. Place inside title tags.
{{style}}
An area in the head tag where the github style block will be added. Don't place inside style tags.
{{body}}
The body text placeholder