typedoc-plugin-github-widget
v1.0.0
Published
A plugin for TypeDoc that adds a Github widget to the header
Downloads
71
Maintainers
Readme
typedoc-plugin-github-widget
A plugin for TypeDoc that adds a Github widget to the header.
Example
A basic example is available at https://mrfigg.github.io/typedoc-plugin-github-widget.
Installation
$ npm install -D typedoc-plugin-github-widgetOptions
The following options are added to TypeDoc when the plugin is installed:
| Option | Type | Default | Description |
| ---------------------- | ------ | ----------- | ------------------------------------------------------------------------------------------------------------- |
| githubWidgetUrl | string | undefined | The URL of the Github repository. If not specified, it will be inferred from the project's package.json file. |
| githubWidgetTarget | string | "_blank" | The target attribute for the Github widget link. |
