{"id":15107072,"url":"https://github.com/mkdocstrings/typescript","last_synced_at":"2026-03-07T17:02:10.484Z","repository":{"id":227514890,"uuid":"720070789","full_name":"mkdocstrings/typescript","owner":"mkdocstrings","description":"A TypeScript handler for mkdocstrings. Available to sponsors only.","archived":false,"fork":false,"pushed_at":"2024-08-04T13:42:55.000Z","size":467,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-30T16:43:46.702Z","etag":null,"topics":["mkdocs","mkdocstrings","mkdocstrings-handler","typescript"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/typescript","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocstrings.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-11-17T14:14:11.000Z","updated_at":"2024-10-03T04:00:37.000Z","dependencies_parsed_at":"2024-09-16T07:13:17.209Z","dependency_job_id":null,"html_url":"https://github.com/mkdocstrings/typescript","commit_stats":null,"previous_names":["mkdocstrings/typescript"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Ftypescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Ftypescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Ftypescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Ftypescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/typescript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237763855,"owners_count":19362310,"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":["mkdocs","mkdocstrings","mkdocstrings-handler","typescript"],"created_at":"2024-09-25T21:04:12.567Z","updated_at":"2025-10-23T01:31:25.254Z","avatar_url":"https://github.com/mkdocstrings.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocstrings-typescript\n\n[![ci](https://github.com/mkdocstrings/typescript/workflows/ci/badge.svg)](https://github.com/mkdocstrings/typescript/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/typescript/)\n[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-typescript.svg)](https://pypi.org/project/mkdocstrings-typescript/)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#typescript:gitter.im)\n\nA Typescript handler for mkdocstrings.\n\nWARNING: **Still in prototyping phase!**\nFeedback is welcome.\n\n## Installation\n\n```bash\npip install mkdocstrings-typescript\n```\n\n## Usage\n\nAdd these [TypeDoc](https://typedoc.org/) configuration files to your repository:\n\n```tree hl_lines=\"4 5\"\n./\n    src/\n        package1/\n    typedoc.base.json\n    typedoc.json\n```\n\n```json title=\"typedoc.base.json\"\n{\n  \"$schema\": \"https://typedoc.org/schema.json\",\n  \"includeVersion\": true\n}\n```\n\n```json title=\"typedoc.json\"\n{\n  \"extends\": [\"./typedoc.base.json\"],\n  \"entryPointStrategy\": \"packages\",\n  \"entryPoints\": [\"./src/*\"]\n}\n```\n\nUpdate the entrypoints to match your file layout so that TypeDoc can find your packages. See [TypeDoc's configuration documentation](https://typedoc.org/options/configuration/).\n\nThen in each of your package, add this TypeDoc configuration file:\n\n```tree hl_lines=\"4\"\n./\n    src/\n        package1/\n            typedoc.json\n    typedoc.base.json\n    typedoc.json\n```\n\n```json title=\"typedoc.json\"\n{\n  \"extends\": [\"../../typedoc.base.json\"],\n  \"entryPointStrategy\": \"expand\",\n  \"entryPoints\": [\"src/index.d.ts\"]\n}\n```\n\nAgain, update entrypoints to match your file and package layout. See [TypeDoc's configuration documentation](https://typedoc.org/options/configuration/).\n\n**Your packages must be built for TypeDoc to work.**\n\nYou are now able to use the TypeScript handler to inject API docs in your Markdown pages by referencing package names:\n\n```md\n::: @owner/packageName\n    handler: typescript\n```\n\nYou can set the Typescript handler as default handler:\n\n```yaml\nplugins:\n- mkdocstrings:\n    default_handler: typescript\n```\n\nBy setting it as default handler you can omit it when injecting documentation:\n\n```md\n::: @owner/packageName\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Ftypescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Ftypescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Ftypescript/lists"}