Drop-in customizable project page, API documentation, and Github Pages support for your npm module.
There are two ways to use Docify: globally via the CLI, or locally via the programmatic interface.
Install Docify as a global CLI:
$ npm install -g docify
You'll then have the docify
command available. You can run docify build
in your project to build the docs. Check out the Getting Started guide for more details.
Install Docify into your project:
$ npm install --save-dev docify
Check out the module API docs for details on how to use Docify programmatically.