typedoc-plugin-replace-text

This is a plugin for TypeDoc that replaces text in the documentation.

This includes:

Text in code comments
Text in the main README
Text in included markdown files

You can specify matching patterns and the text they should be replaced with.

This can be useful for:

Creating links from ticket IDs (eg: replace "GH-12345" with a link to https://github.com/your-name/the-repo/issues/12345)
Creating links from author names (eg: link "Your Name" to your GitHub or corporate profile page)
Replacing internal URLs (domains) with external ones
Replacing custom placeholders with anything you like (eg: images)
Removing URLs or other text from your documentation
etc.

Installation

This module can be installed using npm:

$ npm install typedoc-plugin-replace-text --save-dev

TypeDoc automatically detects plugins installed via npm. After installation TypeDoc can be used normally and you can configure this plugin as described below.

Requirements

The plugin requires TypeDoc version 0.23.x to be installed.

Configuration

Extend your TypeDoc config file with a new option named replaceText. The option is defined as an object that looks like this:

"replaceText": {
    "inCodeCommentText": true,
    "inCodeCommentTags": true,
    "inIncludedFiles": true,
    "replacements": [
        {
            "pattern": "(GH-(\\d+))",
            "replace": "[$1](https://github.com/your-name/the-repo/issues/$2)"
        },
        {
            "pattern": "King Kong",
            "flags": "gi",
            "replace": "[King Kong](https://github.com/king-kong)"
        }
    ]
}

Explanation:

Property	Description
inCodeCommentText	Specifies if the plugin should replace in the text of comments (not including the text of tags like the description of parameters for a method) in your code. (optional - defaults to `true`)
inCodeCommentTags	Specifies if the plugin should replace in the text of tags (like the description of parameters for a method) in your code comments. (optional - defaults to `true`)
inIncludedFiles	Specifies if the plugin should replace in included markdown files (this includes the main README). (optional - defaults to `true`)
replacements	The search patterns and texts they should be replaced with. (`pattern` is the search Regex, `flags` are the optional Regex flags that default to `g` and `replace` is the inserted text)

Bugs

Please report bugs here. Thanks for your contribution!

Donate

If you find this piece of software helpful, please consider a donation. Any amount is greatly appreciated.

npm