single-page documentation generation (based on underscore.js documentation formatting) for multi-versioned apps
Single-page documentation generator for multi-versioned apps
Here are some projects using Cassini to generate their documentation:
Cassini is functional both as a CLI utility and a Node.js module:
$ npm install -g cassini[...]$ cassini -hUsage: cassini [options]Options:-h, --help output usage information-V, --version output the version number-i, --input <dir> Input directory.-o, --output <dir> Output directory.-v, --verbose Print verbose output-t, --templates [templatePath] Location of the template files.$ ls -al src/total 24drwxr-xr-x 3 adam staff 102 Aug 30 03:33 .drwxr-xr-x 11 adam staff 374 Aug 30 15:05 ..-rw-r--r-- 1 adam staff 9808 Aug 30 12:00 2.0.0.md$ cassini -i ./src -o ./bin -vtemplate path: /Users/adam/DEV/cassini/src/templates/default/input files: [ '2.0.0.md' ]filename: 2.0.0.md - version: 2.0.02.0.0 => 9808 bytes of Markdown2.0.0 => 11863 bytes of HTMLwriting bin/2.0.0/index.html
Below is a script that I'm using to host cassini-generated documentation on Heroku. It uses cassini as a module to regenerate the HTML from the current markdown contents at startup; enabling continuous deployment of the documentation: Just commit/pull request/merge and push and let the deploy webhooks take care of the rest. (video coming soon?)
var express =pkg =cassini =path =app =;var port = processenvPORT || 5000;app;console;cassini;
I'm hosting documentation with exactly the above code, for free, on Heroku. Take a look at the package.json and Procfile that bring it all together. All that remains is a CI/CD service. (I'm using drone.io)
I've baked in a spin on the Underscore.js documentation design, but that doesn't mean you have to use it. You can customize the templates to look however you like (within some constraints).
Copy the default (handlebars) templates into a templates folder in your project and customize to your liking.