@glorious/pitsby

Docs generator for AngularJS, React, Vue and Vanilla components
11,591 93
vue vuejs components documentation angular spa generator docs angularjs tool design system gui modern legacy single page application web application
Install
npm install @glorious/pitsby
Latest Version:1.37.2
Vue:2
License:MIT
Last Updated:May 31, 2024
Links: GitHub  ·  npm
Maintainer: rcamargo

Pitsby

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

CircleCI Coverage Status

Installation

$ npm install @glorious/pitsby -g

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:

$ pitsby build

Once built, you can see the result serving the files just created using http-server or any other lib that you prefer:

$ http-server ./pitsby -p 7000

To keep Pitsby watching the changes that you make on any file listed on pitsby.config.js, run:

$ pitsby build --watch

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.

Related Packages

s3-spa-upload

Upload a single page application to S3 with the right content-type and cache-con...

549,106 28
angular single page application spa vue aws react s3 upload
@stories-js/core

Stories web components to build stories

2,178
angular angularjs components documentation tool vue vuejs backend frontend jamstack +10
vuepress

Minimalistic doc generator with Vue component based layout system

3,662,046 22,717
documentation generator vue
@vuepress/core

Minimalistic doc generator with Vue component based layout system

3,565,041 22,713
documentation generator vue
@farming-labs/nuxt

Nuxt adapter for @farming-labs/docs — content loading and navigation utilities

54,401
docs documentation nuxt

Version History

Version Released Vue License
1.37.2 ^2.6.3 MIT
1.37.0 ^2.6.3 MIT
1.36.3 ^2.6.3 MIT
1.36.2 ^2.6.3 MIT
1.36.1 ^2.6.3 MIT