typedoc-plugin-extras
Advanced tools
A TypeDoc plugin to add extras (favicon, generation date, Google Analytics...) to the output documentation
This plugin only works for HTML documentation.
A TypeDoc plugin to add extras to the output documentation.
<head> of the documents and append a favicon to it.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 --footerDate and --footerTime options 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 a gtag.js snippet.
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 build
Then, you can generate the documentation with the plugin (from source):
npm test
FAQs
A TypeDoc plugin to add extras (favicon, description, generation date...) to the output documentation
We found that typedoc-plugin-extras demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
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.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.