Releases

Versioning

This section should help you understand the versioning rules of the plugin and its compatibility with TypeDoc.

Package Version

Please note that TypeDoc is still released within the 0.x.x range, and minor version releases may include breaking changes.

A new plugin release may be published for each TypeDoc minor release. If the TypeDoc update introduces breaking changes for this plugin, we will publish a major plugin version rather than a minor version.

Apart from aligning with TypeDoc releases, the plugin aims to follow semantic versioning:

• Bug fixes, including minor UI tweaks, will be released as patch versions.
• New features or options will be released as minor versions.
• Non-breaking UI changes will be released as minor versions.
• Breaking changes, including option changes and fundamental UI changes, will be released as major versions.

Compatibility Table

The following table shows compatibility between the plugin and TypeDoc.

Node.js and TypeScript requirements follow those supported by the corresponding TypeDoc version.

For Node.js and TypeScript requirements, see the TypeDoc requirements .