It can find the <head> of the document and append a favicon to it.
It can also add date/time of generation after "Generated using TypeDoc" in the footer (see Example).

No date/time will be added if --hideGenerator is set (because the footer wouldn't exist).

Feel free to ask for another extra or to make a PR 😉

Example

Installation

npm install --save-dev typedoc-plugin-extras

Usage

$ npx typedoc --plugin typedoc-plugin-extras [args]

Arguments

The following arguments can be used in addition to the default TypeDoc arguments.

--favicon
Specify the name of the favicon file.
Example: public/favicon.ico
--footerTypedocVersion
Appends the TypeDoc version in the footer.
Default: false
--footerDate
Appends the date of generation in the footer.
Default: false
--footerTime
Appends the time of generation in the footer.
Default: false

Note:

All extras are disabled by default, they are now opt-in.
When favicon is enabled, its file is copied into the documentation's output directory (--out).

Testing

To test this plugin, you can generate TypeDoc documentation for this plugin.

To do this, you'll first need to build the plugin:

npm run build

Then, link the package to have it in the local node_modules:

npm link

You can now generate the documentation with the plugin (from the source):

npm run test

License

MIT

Keywords

FAQs

What is typedoc-plugin-extras?

Is typedoc-plugin-extras popular?

Is typedoc-plugin-extras well maintained?

Package last updated on 12 Sep 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install