https://github.com/drarig29/typedoc-plugin-extras
A plugin for TypeDoc which adds extras to the generated documentation
https://github.com/drarig29/typedoc-plugin-extras
hacktoberfest typedoc typedoc-plugin
Last synced: about 1 year ago
JSON representation
A plugin for TypeDoc which adds extras to the generated documentation
- Host: GitHub
- URL: https://github.com/drarig29/typedoc-plugin-extras
- Owner: Drarig29
- License: mit
- Created: 2020-05-09T23:44:20.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T17:28:57.000Z (over 1 year ago)
- Last Synced: 2025-05-09T00:17:39.395Z (about 1 year ago)
- Topics: hacktoberfest, typedoc, typedoc-plugin
- Language: TypeScript
- Homepage: https://drarig29.github.io/typedoc-plugin-extras/
- Size: 304 KB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typedoc-plugin-extras
[](https://www.npmjs.com/package/typedoc-plugin-extras)
**This plugin only works for HTML documentation.**
A [TypeDoc](https://github.com/TypeStrong/typedoc) plugin to add extras to the output documentation.
It allows you to:
- Add the date/time of generation after "Generated using TypeDoc" in the footer. (cf. the [example](#example) below)
- Set a custom top-most title name (without changing the package name, like `--name` would do).
- For example, you could have `--customTitle "Go back" --titleLink `
- And more... (cf. the list of [arguments](#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 😉
> [!IMPORTANT]
> TypeDoc [now natively supports specifying a favicon](https://typedoc.org/documents/Options.Output.html#favicon). Consequently, the `--favicon` option in this plugin has been removed to prevent conflicts.
## Example
You also can view an example documentation using the plugin here:
https://drarig29.github.io/typedoc-plugin-extras/
## Installation
```bash
npm install --save-dev typedoc-plugin-extras
```
## Usage
```bash
$ npx typedoc --plugin typedoc-plugin-extras [args]
```
## Arguments
The following arguments can be used in addition to the default [TypeDoc arguments](https://github.com/TypeStrong/typedoc#arguments).
- `--customTitle`
Specify a custom title, for the top-most title only.
Example: `foo`
- `--customDescription`
Specify a custom `
Example: `An example description`
- `--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".
## Testing
To test this plugin, you can generate TypeDoc documentation for this plugin.
To do so, you'll first need to build it:
```bash
npm run build
```
Then, you can generate the documentation with the plugin (from source):
```bash
npm test
```
## License
[MIT](./LICENSE)