A TypeDoc plugin to add extras (favicon, description, generation date...) to the output documentation
npm install typedoc-plugin-extras
This plugin only works for HTML documentation.
A TypeDoc plugin to add extras to the output documentation.
It allows you to:
- Add the date/time of generation after "Generated using TypeDoc" in the footer. (cf. the example below)
- Set a custom top-most title name (without changing the package name, like --name would do).
- For example, you could have --customTitle "Go back" --titleLink
- And more... (cf. the list of arguments below)
No date/time will be added if --hideGenerator is set (because the footer wouldn't exist).
All extras are disabled by default: they are opt-in.
Feel free to ask for another extra or to make a PR 😉
> [!IMPORTANT]
> TypeDoc now natively supports specifying a favicon. Consequently, the --favicon option in this plugin has been removed to prevent conflicts.
You also can view an example documentation using the plugin here:
https://drarig29.github.io/typedoc-plugin-extras/
``bash`
npm install --save-dev typedoc-plugin-extras
`bash`
$ npx typedoc --plugin typedoc-plugin-extras [args]
The following arguments can be used in addition to the default TypeDoc arguments.
- --customTitle
Specify a custom title, for the top-most title only.
Example:
- --customDescription
Specify a custom
Example: An example description
- --footerTypedocVersion
Appends the TypeDoc version in the footer.
Default:
- --footerLastModified
Appends a "Last Modified" text in the footer (e.g. "Last modified 6 min. ago").
Default:
Note: If specified, the and --footerTime options are ignored.
- --footerDate (deprecated)false
Appends the date of generation in the footer (e.g. "Jul 29, 2022").
Default:
Note: If combined with , it will append "Jul 29, 2022, 3:44:42 PM GMT+2".
- --footerTime (deprecated)false
Appends the time of generation in the footer (e.g. "3:44:42 PM GMT+2").
Default:
Note: If combined with , it will append "Jul 29, 2022, 3:44:42 PM GMT+2".
To test this plugin, you can generate TypeDoc documentation for this plugin.
To do so, you'll first need to build it:
`bash`
npm run build
Then, you can generate the documentation with the plugin (from source):
`bash``
npm test