Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakubandrysek/mkdocs-typedoc
📇 The MkDocs-Typedoc Plugin is a MkDocs plugin that allows you to include TypeDoc documentation in your MkDocs site.
https://github.com/jakubandrysek/mkdocs-typedoc
api mkdocs mkdocs-plugin typedoc typescript
Last synced: 3 days ago
JSON representation
📇 The MkDocs-Typedoc Plugin is a MkDocs plugin that allows you to include TypeDoc documentation in your MkDocs site.
- Host: GitHub
- URL: https://github.com/jakubandrysek/mkdocs-typedoc
- Owner: JakubAndrysek
- License: mit
- Created: 2023-07-02T15:54:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-03T20:24:30.000Z (8 months ago)
- Last Synced: 2024-12-15T20:43:06.305Z (7 days ago)
- Topics: api, mkdocs, mkdocs-plugin, typedoc, typescript
- Language: Python
- Homepage: https://typedoc.kubaandrysek.cz
- Size: 732 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mkdocs-Typedoc Plugin
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/)