This plugin only works for HTML documentation.
A TypeDoc plugin to add extras to the output documentation.
- It can set a custom top-most title name and/or link.
- It can find the
<head>of the documents and append a favicon to it. - It can also add date/time of generation after "Generated using TypeDoc" in the footer. (cf. the example below)
- 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 😉
You also can view an example documentation using the plugin here:
https://drarig29.github.io/typedoc-plugin-extras/
npm install --save-dev typedoc-plugin-extras$ 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:foo -
--customTitleLink
Specify a custom link for the top-most title.
Example:https://parent-docs-site.com -
--customDescription
Specify a custom meta description.
Example:A test description -
--favicon
Specify the path or URL of the favicon file.
Example:public/favicon.ico
Note: If given a path, the favicon file is copied into the documentation's output directory (--out). -
--footerTypedocVersion
Appends the TypeDoc version in the footer.
Default:false -
--footerLastModified
Appends a "Last Modified" text in the footer (e.g. "Last modified 6 min. ago").
Default:false
Note: If specified, the--footerDateand--footerTimeoptions are ignored. -
--footerDate(deprecated)
Appends the date of generation in the footer (e.g. "Jul 29, 2022").
Default:false
Note: If combined with--footerTime, it will append "Jul 29, 2022, 3:44:42 PM GMT+2". -
--footerTime(deprecated)
Appends the time of generation in the footer (e.g. "3:44:42 PM GMT+2").
Default:false
Note: If combined with--footerDate, it will append "Jul 29, 2022, 3:44:42 PM GMT+2". -
--gaMeasurementId
Specify a Google Analytics measurement ID to insert in agtag.jssnippet.
Example:abc123
To test this plugin, you can generate TypeDoc documentation for this plugin.
To do so, you'll first need to build it:
npm run buildThen, you can generate the documentation with the plugin (from source):
npm test