typedoc-plugin-header-links
v1.0.0
Published
A plugin for TypeDoc which adds the ability to add links to the header
Downloads
3
Maintainers
Readme
typedoc-plugin-header-links
This plugin only works for HTML documentation.
A plugin for TypeDoc which adds the ability to add custom links to the header.
Installation
npm install --save-dev typedoc-plugin-header-links
Usage
$ npx typedoc --plugin typedoc-plugin-header-links [args]
Arguments
The following arguments can be used in addition to the default TypeDoc arguments.
Testing
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 the current repo, to have it in the local node_modules
:
npm link
npm link typedoc-plugin-header-links
You can now generate the documentation with the plugin (from the source):
npm run test
License
Based on this plugin by Drarig29: https://github.com/Drarig29/typedoc-plugin-extras