{"id":15188422,"url":"https://github.com/jakubandrysek/mkdocs-typedoc","last_synced_at":"2025-09-11T12:31:41.613Z","repository":{"id":178156498,"uuid":"661362188","full_name":"JakubAndrysek/mkdocs-typedoc","owner":"JakubAndrysek","description":"📇 The MkDocs-Typedoc Plugin is a MkDocs plugin that allows you to include TypeDoc documentation in your MkDocs site.","archived":false,"fork":false,"pushed_at":"2024-05-03T20:24:30.000Z","size":750,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-02T19:17:03.627Z","etag":null,"topics":["api","mkdocs","mkdocs-plugin","typedoc","typescript"],"latest_commit_sha":null,"homepage":"https://typedoc.kubaandrysek.cz","language":"Python","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/JakubAndrysek.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,"publiccode":null,"codemeta":null}},"created_at":"2023-07-02T15:54:43.000Z","updated_at":"2024-07-05T14:24:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"13bad141-1d20-4e5e-affd-f0ecec468a4d","html_url":"https://github.com/JakubAndrysek/mkdocs-typedoc","commit_stats":null,"previous_names":["jakubandrysek/mkdocs-typedoc"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-typedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-typedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-typedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakubAndrysek%2Fmkdocs-typedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JakubAndrysek","download_url":"https://codeload.github.com/JakubAndrysek/mkdocs-typedoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232646350,"owners_count":18555273,"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":["api","mkdocs","mkdocs-plugin","typedoc","typescript"],"created_at":"2024-09-27T19:05:12.889Z","updated_at":"2025-01-05T21:48:58.671Z","avatar_url":"https://github.com/JakubAndrysek.png","language":"Python","funding_links":["https://github.com/sponsors/jakubandrysek"],"categories":[],"sub_categories":[],"readme":"# Mkdocs-Typedoc Plugin\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://hits.seeyoufarm.com\"\u003e\u003cimg src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJakubAndrysek%2Fmkdocs-typedoc\u0026count_bg=%2379C83D\u0026title_bg=%23555555\u0026icon=\u0026icon_color=%23E7E7E7\u0026title=hits\u0026edge_flat=true\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/blob/main/LICENSE\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/license/JakubAndrysek/mkdocs-typedoc?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://pypi.org/project/mkdocs-typedoc/\" target=\"_blank\"\u003e\u003cimg alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/mkdocs-typedoc?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/stargazers\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/JakubAndrysek/mkdocs-typedoc?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/forks\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/forks/JakubAndrysek/mkdocs-typedoc?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/issues\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/issues/JakubAndrysek/mkdocs-typedoc?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/discussions\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/github/discussions/JakubAndrysek/mkdocs-typedoc?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://pypistats.org/packages/mkdocs-typedoc\" target=\"_blank\"\u003e\u003cimg src=\"https://static.pepy.tech/personalized-badge/mkdocs-typedoc?period=month\u0026units=international_system\u0026left_color=black\u0026right_color=orange\u0026left_text=Downloads\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThe Mkdocs-Typedoc Plugin is designed to integrate TypeDoc documentation with your MkDocs project.\n\n## Installation\n\nInstall the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-typedoc/):\n\n```bash\npip install mkdocs-typedoc\n```\n\nEnsure that you have [Node.js](https://nodejs.org/en/) installed in your system. If not, you can download it from the official website.\n\nAlso, install [TypeDoc](https://typedoc.org/) using [NPM](https://www.npmjs.com/):\n\n```bash\nnpm install typedoc typescript --save-dev\n```\n\n## Usage\n\nAdd the following lines to your mkdocs.yml:\n\n```yaml\nplugins:\n  - typedoc:\n      source: './ts-examples/@types/*.d.ts'\n      output_dir: 'typedocApi'\n      tsconfig: './ts-examples/tsconfig.json'\n      options: 'typedoc.json'\n      name: 'API Doc'\n      disable_system_check: False\n      title_link: \"/\" # optional, default: '/'\n```\n\n- `source` (required): The path to your TypeScript source code.\n- `output_dir` (optional): The directory where you want to output your docs. Default is \"typedoc\".\n- `tsconfig` (required): The path to the tsconfig file for your project.\n- `options` (optional): The path to the typedoc.json options file with more options.\n- `name` (optional): The name for the generated documentation. Default is \"TypeDoc API\".\n- `disable_system_check` (optional): Disable the TypeScript system check. Default is False.\n- `title_link` (optional): The link from TypeDoc back to the main page. Default is \"/\".\n\nThe plugin will generate TypeDoc documentation into the output directory specified.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## Do You Enjoy My Work?\nThen you can consider:\n\n- supporting me on GitHub Sponsors: [![](https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026logo=GitHub\u0026color=%23fe8e86)](https://github.com/sponsors/jakubandrysek)\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakubandrysek%2Fmkdocs-typedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjakubandrysek%2Fmkdocs-typedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjakubandrysek%2Fmkdocs-typedoc/lists"}