docify
v0.1.7
Published
Drop-in customizable project page, API documentation, and Github Pages support for your npm module.
Downloads
24
Readme
docify
Drop-in customizable project page, API documentation, and Github Pages support for your npm module.
Check out the documentation website (generated with Docify and hosted on Github Pages!) for details on how to use Docify.
Installation
There are two ways to use Docify: globally via the CLI, or locally via the programmatic interface.
Installing the CLI globally
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.
Installing the module locally
Install Docify into your project:
$ npm install --save-dev docify
Check out the module API docs for details on how to use Docify programmatically.
License
MIT © Dave Wasmer