{"id":19124405,"url":"https://github.com/glorious-codes/glorious-pitsby","last_synced_at":"2025-04-24T00:23:10.615Z","repository":{"id":33444583,"uuid":"158036849","full_name":"glorious-codes/glorious-pitsby","owner":"glorious-codes","description":"Docs generator for AngularJS, Vue, React, and Vanilla components.","archived":false,"fork":false,"pushed_at":"2024-05-31T19:01:38.000Z","size":5379,"stargazers_count":92,"open_issues_count":8,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-14T18:19:47.775Z","etag":null,"topics":["angularjs","custom-elements","documentation-tool","vanilla-javascript","vue","webcomponents"],"latest_commit_sha":null,"homepage":"https://pitsby.compilorama.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/glorious-codes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-18T00:29:43.000Z","updated_at":"2024-12-18T11:56:45.000Z","dependencies_parsed_at":"2024-06-18T22:42:42.741Z","dependency_job_id":"e94b44aa-c66e-4934-80b8-b709cae9ced7","html_url":"https://github.com/glorious-codes/glorious-pitsby","commit_stats":{"total_commits":534,"total_committers":4,"mean_commits":133.5,"dds":"0.17041198501872656","last_synced_commit":"538e1a86d9f40b290a6f8ff5590a41cc4d1ada47"},"previous_names":[],"tags_count":124,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glorious-codes%2Fglorious-pitsby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glorious-codes%2Fglorious-pitsby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glorious-codes%2Fglorious-pitsby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glorious-codes%2Fglorious-pitsby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glorious-codes","download_url":"https://codeload.github.com/glorious-codes/glorious-pitsby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250536322,"owners_count":21446715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angularjs","custom-elements","documentation-tool","vanilla-javascript","vue","webcomponents"],"created_at":"2024-11-09T05:29:01.134Z","updated_at":"2025-04-24T00:23:10.584Z","avatar_url":"https://github.com/glorious-codes.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pitsby\n\u003e Docs generator for AngularJS, React, Vue and Vanilla components.\n\n[![CircleCI](https://circleci.com/gh/glorious-codes/glorious-pitsby/tree/master.svg?style=svg)](https://circleci.com/gh/glorious-codes/glorious-pitsby/tree/master)\n[![Coverage Status](https://coveralls.io/repos/github/glorious-codes/glorious-pitsby/badge.svg?branch=master)](https://coveralls.io/github/glorious-codes/glorious-pitsby?branch=master)\n\n## Installation\n\n```\n$ npm install @glorious/pitsby -g\n```\n\n## Usage\n\n### Setup\n\nPitsby is based on two types of file:\n\n- [Configuration File](https://github.com/glorious-codes/glorious-pitsby/blob/master/docs/configuration.md) (pitsby.config.js)\n  - Responsible for telling Pitsby where the documentation files are and for informing all the assets that should be included in the documentation.\n- [Documentation File](https://github.com/glorious-codes/glorious-pitsby/blob/master/docs/documentation.md) (eg. button.doc.js)\n  - Used by Pitsby to build the page that contains all the component details.\n\n### Build\n\nSince you have set up the `pitsby.config.js` for your project and, at least, one documentation file, you can easily generate the documentation running:\n```\n$ pitsby build\n```\n\nOnce 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:\n```\n$ http-server ./pitsby -p 7000\n```\n\nTo keep Pitsby watching the changes that you make on any file listed on `pitsby.config.js`, run:\n```\n$ pitsby build --watch\n```\n\n*Go to `http://localhost:7000` and see the documentation that has been just created.*\n\n## Contributions\n\nIf 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglorious-codes%2Fglorious-pitsby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglorious-codes%2Fglorious-pitsby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglorious-codes%2Fglorious-pitsby/lists"}