/Documentor

Super intuitive documentation generator, from markdown files to a single html file (style, scripts, images, search engine embedded) 📖 

Primary LanguageJavaScript

A super intuitive doc generator from Markdown files

Installation

npm -g i documentor

or for yarn users: yarn global add documentor

Quick Usage

documentor init  # initialisation of the documentation
documentor ./docs-folder -o output.html  # render the documentation to output.html

https://i.imgur.com/whek9Zm.png

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
  • -q, --quite: Do not output any message
  • -v, --verbose: Increase the verbosity
  • --var, --variable: Set or override config variable(s)
  • -h, --help: Show help

Examples

Generate project.html from ./docs folder

documentor ./docs -o out.html

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

documentor docs -c conf.yml

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

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

documentor docs -o out.html -w

Dev

npm i

You can run the CLI version with node bin/documentor.js, for example node bin/documentor.js ./docs -o out.html.

Test

npm test

Screenshot

TODO

  • Embed images from markdown
  • Add processing indicator