Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

4.1.0 - 2024-12-09

Added

Added support for latest TypeDoc version 0.27.x.

4.0.0 - 2024-07-16

BREAKING CHANGES

Support changed to TypeDoc versions 0.26.x due to a breaking change in TypeDoc's API.
Option 'inIncludedFiles' has been replaced by the option 'inMarkdown' (see README).

3.3.0 - 2024-01-21

Added

When using a replacer function one now has access to the source code location through the function context "this". (see README example)

3.2.0 - 2023-09-01

Added

Added support for latest TypeDoc version 0.25.x.

3.1.0 - 2023-07-16

Added

The plugin now includes typings for its configuation that you can use in your TypeDoc config. (see Issue #6 on GH)

3.0.0 - 2023-06-11

BREAKING CHANGES

Support changed to TypeDoc versions 0.24.8 and above because we need a new TypeDoc event to fix a bug properly.

Added

You can now define a replacer function in your config that is called for each pattern match. (see Issue #4 on GH)

Fixed

Option inIncludedFiles is too greedy and overrides the other options when set to true. (see Issue #5 on GH)

2.2.0 - 2023-04-15

Changes

Added support for latest TypeDoc version 0.24.x.

2.1.0 - 2022-10-26

Changes

Option value inIncludedFiles now also applies to all included markdown files.

2.0.0 - 2022-07-09

BREAKING CHANGES

Support changed to TypeDoc versions 0.23.x due to a breaking change in TypeDoc's API.

1.0.0 - 2022-04-07

First release