1.0.0 • Published 10 months ago

typedoc-plugin-github-widget v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

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-widget

Options

The following options are added to TypeDoc when the plugin is installed:

OptionTypeDefaultDescription
githubWidgetUrlstringundefinedThe URL of the Github repository. If not specified, it will be inferred from the project's package.json file.
githubWidgetTargetstring"_blank"The target attribute for the Github widget link.
typedocplugintypedoc-plugintypedocplugingithubwidget
jsdom
1.0.0

10 months ago