markdown-notes v1.0.3

Markdown Notes

Use Markdown Notes to generate good looking HTML pages from Markdown files.

It generates HTML pages (from Handlebars templates) from a directory of Markdown files (with optional front-matter) and includes an index.html of all the files. Also features highlight.js code highlighting.

Installation

The easiest way is to globally install the module like this:

npm install -g markdown-notes

Usage

Let's assume you have a directory of Markdown files called notes that look like this:

---
title: JavaScript notes
---

## If statement

Use an If statement like this:

`if (true) {}`

## For loop

A For loop looks like this:

`for (i = 0; i < 10; i++) { }`

In the parent directory of notes execute:

markdown-notes --init

This will copy templates/default and the notes.json configuration file.

After the init you can run it using:

markdown-notes

This will generate the HTML pages from the Markdown files.

Configure

Optionally edit notes.json to your liking:

{
    "src": "notes/",
    "dest": "dist/",
    "template": "default",
    "copy": [
        { 
            "src" : "templates/default/css/main.css",
            "dest": "css/main.css"
        }
    ]
}