{"id":19197872,"url":"https://github.com/flarebyte/baldrick-doc-ts","last_synced_at":"2026-05-16T06:34:33.442Z","repository":{"id":44772609,"uuid":"442545961","full_name":"flarebyte/baldrick-doc-ts","owner":"flarebyte","description":"Document generator for typescript projects","archived":false,"fork":false,"pushed_at":"2023-04-20T06:29:55.000Z","size":246,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-09T02:23:08.602Z","etag":null,"topics":["documentation","markdown","npm-cli","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/flarebyte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-12-28T18:08:57.000Z","updated_at":"2023-05-13T06:49:40.000Z","dependencies_parsed_at":"2024-11-22T08:50:57.603Z","dependency_job_id":null,"html_url":"https://github.com/flarebyte/baldrick-doc-ts","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"cdab93a85648b6e968236ca96d0ed269ad4e332c"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/flarebyte/baldrick-doc-ts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fbaldrick-doc-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fbaldrick-doc-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fbaldrick-doc-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fbaldrick-doc-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flarebyte","download_url":"https://codeload.github.com/flarebyte/baldrick-doc-ts/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flarebyte%2Fbaldrick-doc-ts/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33092689,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T04:41:52.686Z","status":"ssl_error","status_checked_at":"2026-05-16T04:41:52.009Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","markdown","npm-cli","typescript"],"created_at":"2024-11-09T12:19:02.903Z","updated_at":"2026-05-16T06:34:33.410Z","avatar_url":"https://github.com/flarebyte.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# baldrick-doc-ts\n\n![npm](https://img.shields.io/npm/v/baldrick-doc-ts) ![Build status](https://github.com/flarebyte/baldrick-doc-ts/actions/workflows/main.yml/badge.svg) ![npm bundle size](https://img.shields.io/bundlephobia/min/baldrick-doc-ts)\n\n![npm type definitions](https://img.shields.io/npm/types/baldrick-doc-ts) ![node-current](https://img.shields.io/node/v/baldrick-doc-ts) ![NPM](https://img.shields.io/npm/l/baldrick-doc-ts)\n\n![Experimental](https://img.shields.io/badge/status-experimental-blue)\n\n\u003e Documentation generator for typescript projects\n\nGeneration of documentation for node.js libraries written in Typescript\n\n![Hero image for baldrick-doc-ts](baldrick-doc-ts-hero-512.jpeg)\n\nHighlights:\n\n* Generate helpful documentation for a typescript project.\n* Produce a [markdown file](INTERNAL.md) with an UML diagram in Mermaid of all the dependencies and the relationships between them.\n* Generate API documentation as **markdown**. This provides a more\nbasic documentation that the default `typedoc` but does not generate\nany html or css that would become part of the source code, and may\nraise some warnings with many linters.\n\n* Generate a markdown file with the [common vocabulary](CODE_VOCABULARY.md) used in the function names.\n* Generate a [CSV](internal_functions.csv) with the list of typescript functions from the code base.\n\n\n\nA few examples of commands:\n\nGenerate markdown document describing the api of the library:\n```bash\nnpx baldrick-doc-ts@latest typedoc --json-source pest-spec/fixture/typedoc.json\n\n```\nGenerate CODE_VOCABULARY.md with ngram of the code base vocabulary:\n```bash\nnpx baldrick-doc-ts@latest parse --feature ngram\n\n```\nGenerate INTERNAL.md with UML diagram in Mermaid of the dependencies:\n```bash\nnpx baldrick-doc-ts@latest parse --feature internal\n\n```\nGenerate internal_functions.csv with all the typescript functions:\n```bash\nnpx baldrick-doc-ts@latest parse --feature functions-csv\n\n```\n\n## Documentation and links\n\n* [Code Maintenance](MAINTENANCE.md)\n* [Code Of Conduct](CODE_OF_CONDUCT.md)\n* [Api for baldrick-doc-ts](API.md)\n* [Contributing](CONTRIBUTING.md)\n* [Glossary](GLOSSARY.md)\n* [Diagram for the code base](INTERNAL.md)\n* [Vocabulary used in the code base](CODE_VOCABULARY.md)\n* [Architectural Decision Records](DECISIONS.md)\n* [Contributors](https://github.com/flarebyte/baldrick-doc-ts/graphs/contributors)\n* [Dependencies](https://github.com/flarebyte/baldrick-doc-ts/network/dependencies)\n* [Usage](USAGE.md)\n\n## Related\n\n* [baldrick-zest-engine](https://github.com/flarebyte/baldrick-zest-engine) Run tests declaratively with a few cunning plans\n\n## Installation\n\nThis package is [ESM only](https://blog.sindresorhus.com/get-ready-for-esm-aa53530b3f77).\n\n```bash\nyarn global add baldrick-doc-ts\nbaldrick-doc-ts --help\n```\nOr alternatively run it:\n```bash\nnpx baldrick-doc-ts --help\n```\nIf you want to tun the latest version from github. Mostly useful for dev:\n```bash\ngit clone git@github.com:flarebyte/baldrick-doc-ts.git\nyarn global add `pwd`\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflarebyte%2Fbaldrick-doc-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflarebyte%2Fbaldrick-doc-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflarebyte%2Fbaldrick-doc-ts/lists"}