TypeDoc Plugin Example Tag

typedoc @example tag plugin

Table of Contents

• Prerequisites
• Installation
• Usage
• Versioning
• Authors
• License

Prerequisites

npm i -D typedoc

Installation

npm i -D typedoc-plugin-example-tag

Usage

typedoc ... --plugin typedoc-plugin-example-tag --preferred-example-language javascript ...

The preferred-example-language option is set to typescript by default

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

Authors

• Ardalan Amini - Core Maintainer - @ardalanamini

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details