Installations

npm install @glorious/pitsby

Developer Guide

BETA

Typescript

No

Module System

N/A

Node Version

18.19.0

NPM Version

10.2.3 Pull Requests

Open

3

Total

183

Closed

8

Merged

172

Issues

Open

5

Total

69

Closed

64

Releases

Unable to fetch releases

Contributors

2

Unable to fetch Contributors

View All 2 Contributors

Languages

3

JavaScript

Stylus

HTML

JavaScript (87.74%)

Stylus (8.04%)

HTML (4.21%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

glorious-codes

Download Statistics

Total Downloads

38,546

Last Day

4

Last Week

74

Last Month

265

Last Year

5,147

GitHub Statistics

MIT License

92 Stars

748 Commits

7 Forks

2 Watchers

6 Branches

2 Contributors

Updated on Dec 18, 2024

Maintainers

1

Package Meta Information

Latest Version

1.37.2

Package Id

@glorious/pitsby@1.37.2

Unpacked Size

411.09 kB

Size

90.63 kB

File Count

361

NPM Version

10.2.3

Node Version

18.19.0

Published on

May 31, 2024

Total Downloads

Cumulative downloads

Total Downloads

38,546

Last Day

-75%

4

Compared to previous day

Last Week

60.9%

74

Compared to previous week

Last Month

-27.6%

265

Compared to previous month

Last Year

-46.2%

5,147

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

32

Dev Dependencies

12

@babel/eslint-parser @babel/preset-react angular angular-mocks codecov eslint html-loader-jest jest react react-dom rimraf vue

Pitsby

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

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.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2

/10

Last Scanned on 2025-03-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More