{"id":15046234,"url":"https://github.com/barchart/documentation-generator","last_synced_at":"2025-10-26T13:31:09.899Z","repository":{"id":42779969,"uuid":"251037533","full_name":"barchart/documentation-generator","owner":"barchart","description":"Command-line tool for generating technical documentation sites","archived":false,"fork":false,"pushed_at":"2024-04-17T20:08:36.000Z","size":1283,"stargazers_count":2,"open_issues_count":8,"forks_count":6,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-09-28T13:22:05.815Z","etag":null,"topics":["best-practices","cli","command-line-tool","documentation","jsdoc","nodejs","open-api","public-repository","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/barchart.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2020-03-29T13:23:24.000Z","updated_at":"2024-04-17T18:18:27.000Z","dependencies_parsed_at":"2024-04-09T21:24:01.932Z","dependency_job_id":"0de0cf26-d06b-4ffe-bf00-7735fb46815a","html_url":"https://github.com/barchart/documentation-generator","commit_stats":{"total_commits":237,"total_committers":6,"mean_commits":39.5,"dds":0.5569620253164558,"last_synced_commit":"e315263ae06b56b38c6b1e8b8b99706fffa33fc6"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barchart%2Fdocumentation-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barchart%2Fdocumentation-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barchart%2Fdocumentation-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barchart%2Fdocumentation-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/barchart","download_url":"https://codeload.github.com/barchart/documentation-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219862887,"owners_count":16555951,"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":["best-practices","cli","command-line-tool","documentation","jsdoc","nodejs","open-api","public-repository","swagger"],"created_at":"2024-09-24T20:52:53.480Z","updated_at":"2025-10-26T13:31:04.414Z","avatar_url":"https://github.com/barchart.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @barchart/documentation-generator\n\n[![AWS CodeBuild](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiSkJiVDZVKzIvUkh5Vkpzd1prRHlKbGozYUhiSWFXMEhzZFphdzBhTWRiWnRXK2dGMk1GMU52QS8rcTJBWEJjNXZkOTRpUXpMcFBLdjFoYmhRWVhNNStRPSIsIml2UGFyYW1ldGVyU3BlYyI6IlVubWUzdm0reHVoZE5SaDAiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D\u0026branch=master)](https://github.com/barchart/documentation-generator)\n[![NPM](https://img.shields.io/npm/v/@barchart/documentation-generator)](https://www.npmjs.com/package/@barchart/documentation-generator)\n\nA **command-line tool** that _quickly_ generates _easy-to-maintain_ websites for **technical documentation** adhering to [Barchart's](https://www.barchart.com/solutions) guidelines for content, style, and layout.\n\n### Basic Features\n\n* Emits a single-page web application using [Docsify](https://docsify.js.org/#/), with:\n  * a standard cover page,\n  * a standard sidebar,\n  * a standard page structure, and\n  * a standard stylesheet.\n* Creates skeleton of pages, with:\n  * placeholder pages (written using [Markdown](https://en.wikipedia.org/wiki/Markdown)).\n* Auto-generates SDK documentation from your code, as follows:\n  * parses your JavaScript files,\n  * extracts [JSDoc](https://en.wikipedia.org/wiki/JSDoc) comments, and\n  * emits markdown pages.\n* Auto-generates API documentation for your web service, as follows:\n  * parses your [OpenAPI](https://en.wikipedia.org/wiki/OpenAPI_Specification) file (or URL), and\n  * emits markdown pages.\n* Easy to deploy and maintain using [GitHub Pages](https://pages.github.com/).\n\n### Example Sites\n\nThese Barchart products were documented using this tool; the sites are hosted on [GitHub Pages](https://pages.github.com/):\n\n* [Barchart Market Data SDK](https://docs.barchart.com/marketdata-api-js/#/)\n* [Barchart Alerting Service SDK](https://docs.barchart.com/alerts/#/)\n* [Barchart Watchlist Service SDK](https://docs.barchart.com/watchlist/#/)\n\n### Usage Guide\n\nThis tool was used to document itself (see the [```docs```](./docs) folder). The resulting site has been published here:\n\nhttps://barchart.github.io/documentation-generator/#/\n\nIf you're pathologically incapable of reading documentation — which would be ironic, considering the purpose of this tool — just execute the following shell commands:\n\n```shell\nnpm install -g @barchart/documentation-generator\n\nmkdir my-first-documentation-site\ncd my-first-documentation-site\n\ndocumentation init\ndocumentation serve\n```\n\n### Compatibility\n\nThis tool should be compatible with Node.js version 20.\n\n### Package Managers\n\nThis tool is a *public* package on NPM, named [@barchart/documentation-generator](https://www.npmjs.com/package/@barchart/documentation-generator).\n\n### License\n\nThis software is provided under the MIT license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarchart%2Fdocumentation-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarchart%2Fdocumentation-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarchart%2Fdocumentation-generator/lists"}