Skip to content
This repository has been archived by the owner on Jun 5, 2019. It is now read-only.

Latest commit

 

History

History
30 lines (21 loc) · 963 Bytes

README.md

File metadata and controls

30 lines (21 loc) · 963 Bytes

Asynchronously convert a Markdown file into HTML. WOW!

You can specify either the contents of a file, or, the path to a file to read.

Usage

var roaster = require("roaster");
var fs = require("fs");
var options = {}

roaster("./markdown.md", options, function(err, contents) {
	fs.writeFileSync("./markdown.html", contents, "utf8");
});

Options

The second parameter, options, is optional. Any options defined here are passed to the dependent libraries for use in their own systems.

If you pass options.isFile, the first parameter is assumed to be a file path. By default, this is false, which means that the first parameter is an actual string of Markdown.

Libraries used