# component-docs-generator

> component docs generator for ice

Latest version **1.0.3** (published 2018-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install component-docs-generator
pnpm add component-docs-generator
yarn add component-docs-generator
bun add component-docs-generator
```

## Health

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

Positive: no vulnerabilities; popular repo.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2018-11-21 |
| First published | 2018-11-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18599 |
| Author | chenbin92 |
| Maintainers | chenbin93 |

## Links

- npm: https://www.npmjs.com/package/component-docs-generator
- Repository: https://github.com/alibaba/ice/tree/master/tools/component-docs-generator
- npm.io page: https://npm.io/package/component-docs-generator

## Dependencies (3)

- [glob](https://npm.io/package/glob.md) ^7.1.3
- [@alifd/doc-parser](https://npm.io/package/@alifd/doc-parser.md) ^1.0.1
- [@alifd/api-extractor](https://npm.io/package/@alifd/api-extractor.md) ^3.3.2

## Recent versions

- 1.0.3 (latest) — 2018-11-21
- 1.0.2 — 2018-11-20
- 1.0.1 — 2018-11-16
- 1.0.0 — 2018-11-08

## README

## Usage

用于 ICE 业务组件的文档生成器

```js
import docsGen from 'components-docs-generator';

/**
 * @param {string} sourceDir      输入的文件目录，必须
 * @param {string} destDir        输出的文件目录，可选，默认为 process.cwd()
 * @param {string} outputFilename 输出的文件名称，可选，默认为 biz-components.json
 */
docsGen(sourceDir, destDir, outputFilename)
  .then((res) => {
    console.log(res);
  })
  .catch((err) => {
    console.log(err);
  });
```

---
_Source: https://npm.io/package/component-docs-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
