grunt-joli-markdown

Grunt Joli Markdown

Markdown documentation generator based on mixu/markdown-styles
Github Markdown Cheatsheeet

Install

npm install grunt-joli-markdown

Usage

grunt.config.init({
    joli_markdown:{
        options: {
            input: './docs',
            output: './public/docs',
            layout: 'joli-markdown-light'
        }
    }
};

meta.json

{
    "index": {
        "base": "index.html",
        "title": "Grunt Joli Markdown",
        "sections": [
            {"url": "index.html#install","body": "Install"},
            {"url": "index.html#usage","body": "Usage"},
            {"url": "index.html#toc","body": "TOC"},
            {"url": "index.html#options","body": "Options"},
            {"url": "index.html#screenshot","body": "Screenshot"}
        ],
        "repoUrl": "https://gihub.com",
        "menu": [
            {"url": "pages/hello_world.html","body": "Hello World"}
        ]
    },
    "all": {
        "base": "../index.html",
        "title": "Grunt Joli Markdown",
        "repoUrl": "https://gihub.com",
        "menu": [
            {"url": "pages/hello_world.html","body": "Hello World"},
            {"url": "pages/introduction.html","body": "Intoduction"}
        ]
    }
}

Toc

@see markdown-styles

Options

Required

options.input

.md Files folder
Type: String

options.output

HTML Documentation output folder
Type: String

Optionnal

options.layout

HTML Documentation skin
Type: String
Default value: joli-markdown
Possible values:

• joli-markdown
• joli-markdown-light
• @see markdown-styles

Changelog

• v0.1.12
  • options.input & options.ouput are relative to grunt task
• v0.1.8
  • remove markdown-styles global install
  • install sixertoy/markdown-styles
  • add 'all' section in 'meta.jon' overrided by page's section

Screenshot

joli-markdown

joli-markdown-light