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:

pip install mkdocs-typedoc

Ensure that you have Node.js installed in your system. If not, you can download it from the official website.

Also, install TypeDoc using NPM:

npm install typedoc typescript --save-dev

Usage

Add the following lines to your mkdocs.yml:

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

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.

The plugin will generate TypeDoc documentation into the output directory specified.

Windows machines

System might not work on Windows machines, if you would like to test it on Windows, set disable_system_check to True.

Error message:

INFO     -  Building documentation...
INFO     -  Cleaning site directory
ERROR    -  TypeDoc: TypeDoc failed with error: [WinError 2] The system cannot find the file specified

If anyone knows how to fix this, please let me know or create a pull request.

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 definitely consider:

supporting me on GitHub Sponsors:

License

MIT