typedoc-plugin-extras
Advanced tools
A plugin for TypeDoc which adds extras to the generated documentation
This plugin only works for HTML documentation.
A plugin for TypeDoc which adds extras to the generated 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).
Feel free to ask for another extra or to make a PR 😉
You can view an example documentation using this 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 name or URL 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:
--out).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
You can now generate the documentation with the plugin (from the source):
npm test
FAQs
A TypeDoc plugin to add extras (favicon, description, generation date...) to the output documentation
The npm package typedoc-plugin-extras receives a total of 3,624 weekly downloads. As such, typedoc-plugin-extras popularity was classified as popular.
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.