Octodoc 🐙

Gather all the documentation for your dependencies in one place instantly! 🪄

Installation

Install with npm:

npm i octodoc

or install with yarn:

yarn add octodoc

Initialize:

By installing the package we automatically create your documentation from your dependencies. You don't need to do anything!

How to use it

After initialize octodoc you can watch your documentation by execute the command :

npm run octodoc

this command will start the server where your documentation is located.  

you can update your documentation using the command:

npm run updatedoc

Founder

| Guillaume Reygner | | ----------- | | Octodoc Creator |  

License

Octodoc is licensed under the Hippocratic License.

Code of conduct

This project and everyone participating in it is governed by the Octodoc Code of Conduct. By participating, you are expected to uphold this code.