Pitsby

Docs generator for AngularJS, Vue, React, and Vanilla components.

PlaygroundReactVueWeb ComponentsAngular
glorious-codes/glorious-pitsbypitsby.com@glorious/pitsby

README

Pitsby


Docs generator for AngularJS, React, Vue and Vanilla components.


CircleCI
Coverage Status

Installation


  1. ```
  2. $ npm install @glorious/pitsby -g
  3. ```

Usage


Setup


Pitsby is based on two types of file:

- Configuration File (pitsby.config.js)
  - Responsible for telling Pitsby where the documentation files are and for informing all the assets that should be included in the documentation.
- Documentation File (eg. button.doc.js)
  - Used by Pitsby to build the page that contains all the component details.

Build


Since you have set up the pitsby.config.js for your project and, at least, one documentation file, you can easily generate the documentation running:
  1. ```
  2. $ pitsby build
  3. ```

Once built, you can see the result serving the files just created using http-server or any other lib that you prefer:
  1. ```
  2. $ http-server ./pitsby -p 7000
  3. ```

To keep Pitsby watching the changes that you make on any file listed on pitsby.config.js, run:
  1. ```
  2. $ pitsby build --watch
  3. ```

Go to http://localhost:7000 and see the documentation that has been just created.

Contributions


If you are interested in contributing to this project, refer to the Contributing Steps.