Getting Started

To get started using Markugen in your project, you will need to first install Markugen as a dependency. It is likely that you will be generating your documentation as a build/publish step; therefore, you may want to add --save-dev to the following commands to add it as a dev dependency.

Install Markugen

To install Markugen within your NodeJS project, execute one of the following commands:

Build Your Website

This section assumes you already have a markdown file or a set of markdown files. To generate your website, it is quite simple, just create an instance of the Markugen class and call generate. The following code assumes your markdown files are in a directory called markdown. If your markdown files are in a different folder, just change the input option to point to the location of the folder containing your markdown files.

// import markugen
import Markugen from 'markugen';

// create an instance
const mark = new Markugen();
// generate the website
await mark.generate({
  input: 'markdown',
});

Markugen will output the HTML files to a folder in your current working directory or cwd called output. If you would like to change the output location, provide Markugen with the output location via the output option like so:

// import markugen
import Markugen from 'markugen';

// create an instance
const mark = new Markugen();
// generate the website
await mark.generate({
  input: 'markdown',
  output: 'docs',
});

That's all folks!

Additional Options

Most of Markugen's options have default values associated with them. As a matter of fact, the only required option is the input option; all other options have defaults. A few things to note about the defaults:

• The file name will be used as the title of each page
• The site title will be Markugen v2.0.5 and should be overridden
• Page order is defaulted to alphabetical order