dmd-plugin-zh-cn/README.md

jsdoc-to-markdown in Chinese

[![view on npm](http://img.shields.io/npm/v/dmd-plugin-zh-cn.svg)](https://www.npmjs.org/package/dmd-plugin-zh-cn)
[![npm module downloads per month](http://img.shields.io/npm/dm/dmd-plugin-zh-cn.svg)](https://www.npmjs.org/package/dmd-plugin-zh-cn)

# jsdoc-to-markdown 简体中文汉化插件

这是 [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) 的中文化插件。本插件可以让 jsdoc-to-markdown 输出简体中文版的 markdown 文档。

## 用法

首先，通过 `npm` 安装插件：
```
$ npm install dmd-plugin-zh-cn --save-dev
```

然后把本插件的名字 `dmd-plugin-zh-cn` 输入到 `jsdoc2md` 或 `dmd`：
```
$ jsdoc2md --plugin dmd-plugin-zh-cn lib/*.js 
```

更多详情请参见 [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) 官网。

## 许可

NO LICENSE. 没有任何许可，随便拿去用，也无须注明作者。