defconcepts / mr-doc

A personal source documenter at your service

Artwork by Ben Matsuya.

Mr. Doc is a total refactoring of dox-foundation written in ES6, tranformed to ES5 with Babel, and is based on dox. He can automatically generate beautiful documentations and can further spice up your documentations using themes.

By default, Mr. Doc uses mr-doc-theme-default which uses Twitter Bootstrap for the frontend framework and Prism.js for syntax highlighting.

Visit the official site for instructions to install Mr. Doc and other themes.

Documentation Style

JavaScript JavaDoc style

/**
 * Create an array of all the right files in the source dir
 * @param      {String}   source path
 * @param      {Object}   options
 * @param      {Function} callback
 * @jsFiddle   A jsFiddle embed URL
 * @return     {Array} an array of string path
 */
function collectFiles(source, options, callback) {
  ...
}

Notes

• Mr. Doc supports the following variations of @return and @jsFiddle:
  • @return, @returns
  • @jsfiddle, @jsFiddle, @JSFiddle

CLI

$ mr-doc --help

  Usage: mr-doc [options]

  Options:

    -h, --help                    Outputs usage information.
    -V, --version                 Outputs the version number.
    -e, --extension <extension>  The output files extension. Default: html
    -i, --ignore <directories>   The comma seperated list of directories to ignore. Default: test,public,static,view,views,template,templates
    -j, --template <template>    The Jade template file to use.
    -k, --kit [kit]              Marks the template as a starter-kit with a 'yes' or 'no' (optional).
    -n, --name <name>            The name of your project.
    -o, --output <output>        The directory for the generated docs. Default: <CWD>/docs
    -r, --readme <file>          The markdown file to use on the main page of the documentations. Checks the current directory for a package.json or README.md by default
    -s, --source <source>        The directory to your source.
    -t, --theme <theme>          The name of the theme to select. e.g. mr-doc-theme-cayman or cayman.

Related

• grunt-mrdoc - mr-doc grunt plugin automatically generates the documentation for your project.
• gulp-doxx - mr-doc documentation generator for gulp.

Roadmap

Next

See issue #94.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using gulp and mocha.

Updating Docs

To update the docs on the gh-pages branch:

gulp docs

Changelog

The changes can be viewed here.

Donate

• Donate Bitcoins
• Gratipay (gittip)

License

MIT License

Copyright (c) 2015 Francois-Guillaume Ribreau