> A super intuitive doc generator from Markdown files

Installation

``bash
npm -g i documentor
`

or for yarn users: yarn global add documentor

Quick Usage

`bash
documentor init # initialisation of the documentation
`

`bash
documentor ./docs-folder -o output.html # render the documentation to output.html
`

Documentation

Please check the documentation for more details.

Command Line Usage

- -i, --input: Input folder (optional flag)
- -o, --output: Write in file
- -t, --to: Output format
- -c, --config: Configuration file
- -w, --watch: Watch docs files with partial generation
- -v, --verbose: Configuration file
- --var, --variable: Set or override config variable(s)
- -h, --help: Show help

$3

Generate project.html from ./docs folder

`bash
documentor ./docs -o out.html
`

Output html to STDOUT from ./docs folder and read the configuration file conf.yml

`bash
documentor docs -c conf.yml
`

Generate "out.html" with a custom name and footer

`bash
documentor ./docs -o out.html --var.name "My Project" --var.footer "(c) Project 1.0"
`

Watch the "docs" folder and regenerate "out.html" on change

`bash
documentor docs -o out.html -w
`

Dev

`bash
yarn install
`

$3

`bash
yarn test
``

Screenshot

#### TODO

- [ ] Embed images from markdown