# hc-honeypack-docco-plugin

> docco的文档点击：https://github.com/jashkenas/docco

Latest version **0.0.4** (published 2019-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install hc-honeypack-docco-plugin
pnpm add hc-honeypack-docco-plugin
yarn add hc-honeypack-docco-plugin
bun add hc-honeypack-docco-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2019-03-29 |
| First published | 2018-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 562.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | 雨异 |
| Maintainers | baqian |

## Links

- npm: https://www.npmjs.com/package/hc-honeypack-docco-plugin
- Repository: git@gitlab.alibaba-inc.com:aliyun_FED_tools/naza-docco-plugin
- npm.io page: https://npm.io/package/hc-honeypack-docco-plugin

## Dependencies (6)

- [docco](https://npm.io/package/docco.md) ~0.7.0
- [marked](https://npm.io/package/marked.md) >= 0.2.7
- [fs-extra](https://npm.io/package/fs-extra.md) >= 0.6.0
- [commander](https://npm.io/package/commander.md) >= 0.5.2
- [underscore](https://npm.io/package/underscore.md) >= 1.0.0
- [highlight.js](https://npm.io/package/highlight.js.md) >= 8.0.x

## Recent versions

- 0.0.4 (latest) — 2019-03-29
- 0.0.3 — 2019-03-29
- 0.0.2 — 2018-06-06
- 0.0.1 — 2018-06-06

## README

### webpack docco plugin

docco的文档点击：https://github.com/jashkenas/docco

+ **使用**
```javascript
    var DoccoPlugin = require('@ali/naza-docco-plugin');
    config.plugins.unshift(new DoccoPlugin(options.docco));
```

+ **结合naza-server**
需要在项目的config.local.json中添加docco配置项来启动。支持的参数如下：

```javascript
    docco: {
        dir                 //文件的来源目录
        extension           //编译文档的语言文件，默认是js文件
        template            //自定义docco.jst
        output              //编译的文档放置的目录，默认是dist/docs
        test                //过滤文件
        exclude             //过滤文件
        include             //包含的文件
        css                 //docco.jst中使用css的地址
        'public'            //css文件需要的静态文件
    }
```

---
_Source: https://npm.io/package/hc-honeypack-docco-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._