# TypeScript Docs Generator

**Repository Path**: phoenix-tech/tsdoc

## Basic Information

- **Project Name**: TypeScript Docs Generator
- **Description**: TypeScript documentation auto generator using typedoc - http://typedoc.org/.
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-28
- **Last Updated**: 2022-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @web-io/tsdoc

> TypeScript documentation auto generator using [typedoc](http://typedoc.org/).

## 使用

新建`typedoc.js`配置文件，引用`@web-io/tsdoc`

```javascript
const {defineConfig} = require("@web-io/tsdoc");

module.exports = defineConfig();

// 可传入typedoc configuration
// http://typedoc.org/guides/options/#configuration-options
module.exports = defineConfig({
    includeVersion: false,
    out: "doc"
});
```

## 变更日志

查看[变更日志](CHANGELOG.md)了解更多。