This plugin only works for HTML documentation.
A plugin for TypeDoc that adds extras to the generated documentation (favicon and date/time of generation).
- It can find the
<head>
of the document and append a favicon to it. - It can also add date/time of generation after "Generated using TypeDoc" in the footer (see Example).
No date/time will be added if --hideGenerator
is set (because the footer wouldn't exist).
Feel free to ask for another extras or to make a PR 😉
![npm](https://img.shields.io/npm/v/typedoc-plugin-extras.svg)
Example
![Example](https://github.com/Drarig29/typedoc-plugin-extras/raw/HEAD/public/example.png)
Installation
npm install --save-dev typedoc typedoc-plugin-extras
Usage
$ npx typedoc --plugin typedoc-plugin-extras [args]
Arguments
The following arguments can be used in addition to the default TypeDoc arguments.
--favicon
Specify the name of the favicon file. Default: 'public/favicon.ico'
--noFavicon
Disable the favicon.--hideDate
Hide the date at the end of documentation pages.--hideTime
Hide the time at the end of documentation pages.
Note: Favicon, date and time are enabled by default.
When favicon is enabled, its file is copied into the documentation's output directory (--out
).
License
MIT