typedoc-plugin-extras
Advanced tools
A plugin for TypeDoc that adds extras to the generated documentation (favicon and date/time of generation).
This plugin only works for HTML documentation.
A plugin for TypeDoc that adds extras to the generated documentation (favicon and date/time of generation).
<head> of the document 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 😉
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.
--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:
--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
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
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
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
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.