{"id":13880804,"url":"https://github.com/cdklabs/jsii-docgen","last_synced_at":"2025-07-16T17:31:12.414Z","repository":{"id":37051201,"uuid":"257217645","full_name":"cdklabs/jsii-docgen","owner":"cdklabs","description":"Generates reference documentation for jsii modules","archived":false,"fork":false,"pushed_at":"2025-07-15T15:03:34.000Z","size":15036,"stargazers_count":52,"open_issues_count":17,"forks_count":13,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-07-16T09:15:10.746Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cdklabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"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,"zenodo":null}},"created_at":"2020-04-20T08:26:14.000Z","updated_at":"2025-07-15T08:51:31.000Z","dependencies_parsed_at":"2024-01-23T01:40:08.093Z","dependency_job_id":"b3f126bf-6591-4c46-a6d7-401de2b70ebf","html_url":"https://github.com/cdklabs/jsii-docgen","commit_stats":{"total_commits":1118,"total_committers":25,"mean_commits":44.72,"dds":0.5885509838998211,"last_synced_commit":"d99231852e921ea3d3c48148b18b2a2450dbe9c6"},"previous_names":[],"tags_count":988,"template":false,"template_full_name":null,"purl":"pkg:github/cdklabs/jsii-docgen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdklabs%2Fjsii-docgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdklabs%2Fjsii-docgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdklabs%2Fjsii-docgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdklabs%2Fjsii-docgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cdklabs","download_url":"https://codeload.github.com/cdklabs/jsii-docgen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdklabs%2Fjsii-docgen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265527545,"owners_count":23782480,"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":[],"created_at":"2024-08-06T08:03:30.044Z","updated_at":"2025-07-16T17:31:09.709Z","avatar_url":"https://github.com/cdklabs.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","others"],"sub_categories":[],"readme":"# jsii-docgen\n\nGenerates markdown reference documentation for jsii modules.\n\n## Usage\n\nYou can use this as a command line tool or as a library if you need more control.\n\n```shell\n$ jsii-docgen\n```\n\nWill produce a file called `API.md` with the api reference for this module.\n\nAs a library:\n\n```ts\nimport { Documentation, Language } from 'jsii-docgen';\n\nconst docs = await Documentation.forProject('.');\nconst markdown = await docs.toMarkdown({ language: Language.TYPESCRIPT }).render(); // returns a markdown string\n\nconst json = await docs.toJson({ language: Language.TYPESCRIPT }).render(); // returns a JSON object\n```\n\nCurreently jsii-docgen supports generating documentation in the following languages:\n\n- TypeScript (`typescript`)\n- Python (`python`)\n- Java (`java`)\n- C# (`csharp`)\n- Go (`go`)\n\n\n## CLI Options\n\n| Option                 | Required | Description                                                                                                                              |\n| :--------------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------- |\n| `--output`, `-o`       | optional | Output filename (defaults to API.md if format is markdown, and API.json if format is JSON). \u003cbr /\u003e\u003cbr/\u003e`jsii-docgen -o ./docs/API.md`    |\n| `--format`, `-f`       | optional | Output format. Can be `markdown` or `json`. \u003cbr /\u003e\u003cbr /\u003e`jsii-docgen -f json`                                                            |\n| `--language`, `-l`     | optional | Language to generate documentation for. Can be `typescript`, `python`, `java`, `csharp` or `go`. \u003cbr /\u003e\u003cbr /\u003e`jsii-docgen -l typescript` |\n| `--package`, `-p`      | optional | The name@version of an NPM package to document. \u003cbr /\u003e\u003cbr /\u003e`jsii-docgen -p my-package`                                                  |\n| `--readme`, `-r`       | optional | Generate docs for user specified README.md. \u003cbr /\u003e\u003cbr /\u003e`jsii-docgen -r`                                                                 |\n| `--submodule`, `-s`    | optional | Generate docs for a specific submodule or \"root\". \u003cbr /\u003e\u003cbr /\u003e`jsii-docgen -s my-submodule`                                              |\n| `--split-by-submodule` | optional | Generate a separate file for each submodule. \u003cbr /\u003e\u003cbr /\u003e`jsii-docgen --split-by-submodule`                                              |\n\n## Contributions\n\nAll contributions are welcome, just raise an issue or submit a PR. Add a test,\nupdate readme. Do the right thing.\n\n## License\n\n[Apache 2.0](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdklabs%2Fjsii-docgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcdklabs%2Fjsii-docgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdklabs%2Fjsii-docgen/lists"}