markdocco

Markdocco is a quick-and-dirty, documentation generator, but for slacked markdown only.

Background

Markdocco is inspired by Jash Kenas's Docco.

At the beginning, I use docco to generate the code project, and some day, I have a idea about use slashed markdown, but I want the result generated by docco always to be html, not the docs is html, code is rendered code.

So I folk the docco, and do it by myself.

Usage

Installation:

npm install -g markdocco

Usage: markdocco [options] FILES

Options:

    -h, --help             output usage information
    -V, --version          output the version number
    -l, --layout [layout]  choose a built-in layouts (parallel, linear)
    -c, --css [file]       use a custom css file
    -o, --output [path]    use a custom output path
    -t, --template [file]  use a custom .jst template
    -e, --extension [ext]  use the given file extension for all inputs
    -L, --languages [file] use a custom languages.json
    -m, --marked [file]    use custom marked options

License

Copyright (c) 2019 Richard Libre.

Markdocco is licensed under The MIT License.