# Mkdocs-Typedoc Plugin
<p align="center">
<a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJakubAndrysek%2Fmkdocs-typedoc&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true"/></a>
<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
<a href="https://pypi.org/project/mkdocs-typedoc/" target="_blank"><img alt="PyPI" src="https://img.shields.io/pypi/v/mkdocs-typedoc?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/forks" target="_blank"><img src="https://img.shields.io/github/forks/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/issues" target="_blank"><img src="https://img.shields.io/github/issues/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/discussions" target="_blank"><img src="https://img.shields.io/github/discussions/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
<a href="https://pypistats.org/packages/mkdocs-typedoc" target="_blank"><img src="https://static.pepy.tech/personalized-badge/mkdocs-typedoc?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads"></a>
</p>
The Mkdocs-Typedoc Plugin is designed to integrate TypeDoc documentation with your MkDocs project.
## Installation
Install the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-typedoc/):
```bash
pip install mkdocs-typedoc
```
Ensure that you have [Node.js](https://nodejs.org/en/) installed in your system. If not, you can download it from the official website.
Also, install [TypeDoc](https://typedoc.org/) using [NPM](https://www.npmjs.com/):
```bash
npm install typedoc typescript --save-dev
```
## Usage
Add the following lines to your mkdocs.yml:
```yaml
plugins:
- typedoc:
source: './ts-examples/@types/*.d.ts'
output_dir: 'typedocApi'
tsconfig: './ts-examples/tsconfig.json'
options: 'typedoc.json'
name: 'API Doc'
disable_system_check: False
title_link: "/" # optional, default: '/'
```
- `source` (required): The path to your TypeScript source code.
- `output_dir` (optional): The directory where you want to output your docs. Default is "typedoc".
- `tsconfig` (required): The path to the tsconfig file for your project.
- `options` (optional): The path to the typedoc.json options file with more options.
- `name` (optional): The name for the generated documentation. Default is "TypeDoc API".
- `disable_system_check` (optional): Disable the TypeScript system check. Default is False.
- `title_link` (optional): The link from TypeDoc back to the main page. Default is "/".
The plugin will generate TypeDoc documentation into the output directory specified.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Do You Enjoy My Work?
Then you can consider:
- supporting me on GitHub Sponsors: [](https://github.com/sponsors/jakubandrysek)
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/JakubAndrysek/mkdocs-typedoc",
"name": "mkdocs-typedoc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "mkdocs plugin",
"author": "Jakub Andr\u00fdsek",
"author_email": "email@kubaandrysek.cz",
"download_url": "https://files.pythonhosted.org/packages/4b/5a/aa639db38633f0608c81ae6fb501e61083b06ee5ff8684e970087773a8aa/mkdocs_typedoc-1.0.4.tar.gz",
"platform": null,
"description": "# Mkdocs-Typedoc Plugin\n\n<p align=\"center\">\n<a href=\"https://hits.seeyoufarm.com\"><img src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJakubAndrysek%2Fmkdocs-typedoc&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true\"/></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/blob/main/LICENSE\" target=\"_blank\"><img src=\"https://img.shields.io/github/license/JakubAndrysek/mkdocs-typedoc?style=flat-square\"></a>\n<a href=\"https://pypi.org/project/mkdocs-typedoc/\" target=\"_blank\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/mkdocs-typedoc?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/stargazers\" target=\"_blank\"><img src=\"https://img.shields.io/github/stars/JakubAndrysek/mkdocs-typedoc?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/forks\" target=\"_blank\"><img src=\"https://img.shields.io/github/forks/JakubAndrysek/mkdocs-typedoc?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/issues\" target=\"_blank\"><img src=\"https://img.shields.io/github/issues/JakubAndrysek/mkdocs-typedoc?style=flat-square\"></a>\n<a href=\"https://github.com/JakubAndrysek/mkdocs-typedoc/discussions\" target=\"_blank\"><img src=\"https://img.shields.io/github/discussions/JakubAndrysek/mkdocs-typedoc?style=flat-square\"></a>\n<a href=\"https://pypistats.org/packages/mkdocs-typedoc\" target=\"_blank\"><img src=\"https://static.pepy.tech/personalized-badge/mkdocs-typedoc?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads\"></a>\n</p>\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://github.com/sponsors/jakubandrysek)\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs plugin to generate documentation from TypeScript source code using TypeDoc.",
"version": "1.0.4",
"project_urls": {
"Documentation": "https://typedoc.kubaandrysek.cz/",
"Funding": "https://github.com/sponsors/jakubandrysek",
"Homepage": "https://github.com/JakubAndrysek/mkdocs-typedoc",
"Source": "https://github.com/JakubAndrysek/mkdocs-typedoc",
"Tracker": "https://github.com/JakubAndrysek/mkdocs-typedoc/issues"
},
"split_keywords": [
"mkdocs",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cabd63f4dc5baec203dfc694f820559b8ad7935546e182ce596f377ea44476dd",
"md5": "10d966ff1e0fc1a6a9f952dc7f81d0bc",
"sha256": "a9601d6b04ed4fd5658c7170c58a3a52f584357be2a3c1e39995c6eed3712b1e"
},
"downloads": -1,
"filename": "mkdocs_typedoc-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10d966ff1e0fc1a6a9f952dc7f81d0bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5468,
"upload_time": "2024-05-03T20:23:58",
"upload_time_iso_8601": "2024-05-03T20:23:58.660912Z",
"url": "https://files.pythonhosted.org/packages/ca/bd/63f4dc5baec203dfc694f820559b8ad7935546e182ce596f377ea44476dd/mkdocs_typedoc-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b5aaa639db38633f0608c81ae6fb501e61083b06ee5ff8684e970087773a8aa",
"md5": "382d749f6b8df7233a90ee89f551886e",
"sha256": "839b54c51a64bbb77c1c253eb81baad12462ea5cf38d361e262f5cfa8a45567a"
},
"downloads": -1,
"filename": "mkdocs_typedoc-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "382d749f6b8df7233a90ee89f551886e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5001,
"upload_time": "2024-05-03T20:24:00",
"upload_time_iso_8601": "2024-05-03T20:24:00.327533Z",
"url": "https://files.pythonhosted.org/packages/4b/5a/aa639db38633f0608c81ae6fb501e61083b06ee5ff8684e970087773a8aa/mkdocs_typedoc-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 20:24:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JakubAndrysek",
"github_project": "mkdocs-typedoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "mkdocs-typedoc"
}
JSON
