0.1.17 • Published 10 years ago

grunt-joli-markdown v0.1.17

Weekly downloads
1
License
MIT
Repository
github
Last release
10 years ago

Grunt Joli Markdown Built with Grunt

MIT License NPM version NPM downloads

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:

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

joli-markdown-light

joli-markdown-light

0.1.17

10 years ago

0.1.16

10 years ago

0.1.15

10 years ago

0.1.14

10 years ago

0.1.13

10 years ago

0.1.12

10 years ago

0.1.11

10 years ago

0.1.10

10 years ago

0.1.7

10 years ago

0.1.5

10 years ago

0.1.4

10 years ago

0.1.3

10 years ago

0.1.2

10 years ago

0.1.1

10 years ago

0.1.0

10 years ago