/roaster

Turns a raw and crunchy Markdown file into nice and smooth output

Primary LanguageCoffeeScriptMIT LicenseMIT

Atom and all repositories under Atom will be archived on December 15, 2022. Learn more in our official announcement

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 = { isFile: true };

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

roaster("# Hello World", function(err, contents) {
	fs.writeFileSync("./hello-world.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