typedoc-plugin-rename-documents
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

typedoc-plugin-rename-documents

A plugin for TypeDoc that renames documents without a yaml frontmatter section.

Example

A basic example is available at https://mrfigg.github.io/typedoc-plugin-rename-documents.

Installation

$ npm install -D typedoc-plugin-rename-documents

Options

The following options are added to TypeDoc when the plugin is installed:

Option Type Default Description
renameDocuments Record<string, string> {} A mapping of document files to be renamed. The key is the path to the document file and the value is the new name.

Package Sidebar

Install

npm i typedoc-plugin-rename-documents

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

5.91 kB

Total Files

6

Last publish

Collaborators

  • mrfigg