# @mxssfd/typedoc-theme

- demo
  - [example](https://mengxinssfd.github.io/typedoc-theme/)
  - [request-template](https://mengxinssfd.github.io/request-template/)
- [example-code](https://github.com/mengxinssfd/typedoc-theme/tree/main/example)


<img width="1440" alt="截屏2023-04-11 17 56 04" src="https://user-images.githubusercontent.com/28827520/231126819-e2535010-9872-46ef-ae72-18645717f2ff.png">
<img width="1440" alt="截屏2023-04-11 17 55 25" src="https://user-images.githubusercontent.com/28827520/231126914-84d132fb-074a-453b-8514-69ea705b4faa.png">
<img width="1440" alt="截屏2023-04-11 17 56 49" src="https://user-images.githubusercontent.com/28827520/231126521-7fdaeced-ee87-4015-8be6-45371c3f35fd.png">
<img width="1440" alt="截屏2023-04-11 17 57 06" src="https://user-images.githubusercontent.com/28827520/231126464-26b811d7-c8fc-4e49-b744-a2b7b931f1a5.png">

## Installation

```shell
npm install typedoc @mxssfd/typedoc-theme -D
```

## Usage

use script command

```shell
typedoc --plugin @mxssfd/typedoc-theme --theme my-theme
```

or

use `typedoc.json`

```json
{
  "$schema": "https://typedoc.org/schema.json",
  "plugin": ["@mxssfd/typedoc-theme"],
  "theme": "my-theme"
}
```