https://github.com/glorious-codes/glorious-pitsby
Docs generator for AngularJS, Vue, React, and Vanilla components.
https://github.com/glorious-codes/glorious-pitsby
angularjs custom-elements documentation-tool vanilla-javascript vue webcomponents
Last synced: 11 months ago
JSON representation
Docs generator for AngularJS, Vue, React, and Vanilla components.
- Host: GitHub
- URL: https://github.com/glorious-codes/glorious-pitsby
- Owner: glorious-codes
- License: mit
- Created: 2018-11-18T00:29:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T19:01:38.000Z (almost 2 years ago)
- Last Synced: 2025-04-14T18:19:47.775Z (12 months ago)
- Topics: angularjs, custom-elements, documentation-tool, vanilla-javascript, vue, webcomponents
- Language: JavaScript
- Homepage: https://pitsby.compilorama.com
- Size: 5.13 MB
- Stars: 92
- Watchers: 2
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Pitsby
> Docs generator for AngularJS, React, Vue and Vanilla components.
[](https://circleci.com/gh/glorious-codes/glorious-pitsby/tree/master)
[](https://coveralls.io/github/glorious-codes/glorious-pitsby?branch=master)
## Installation
```
$ npm install @glorious/pitsby -g
```
## Usage
### Setup
Pitsby is based on two types of file:
- [Configuration File](https://github.com/glorious-codes/glorious-pitsby/blob/master/docs/configuration.md) (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](https://github.com/glorious-codes/glorious-pitsby/blob/master/docs/documentation.md) (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](https://www.npmjs.com/package/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](https://github.com/glorious-codes/glorious-pitsby/blob/master/docs/contributing.md).