Post List

2016년 10월 27일 목요일

Walmart Electrode #09 Generate Docs

문서 생성

문서는 component.md와 메타문서인 component.json 으로 이루어져 있다. Electrode-Docgen 을 이용하면, 자동화가 가능하다.

이 문서화 명령은 아래 gulpfile.js 안에 정의되어 있다.

1. 위치 : <your-awesome-component>/gulpfile.js



const tasks = {
  "demo": ["generate", "server-dev"],
  "demo-iso": ["dev-iso"],
  "generate": ["generate-metadata", "generate-documentation"],
  "generate-documentation": () => exec(`electrode-docgen --package ./package.json --src ./src --markdown components.md`),
  "generate-metadata": () => exec(`electrode-docgen --package ./package.json --src ./src --metadata components.json`),
  "prepublish": ["npm:prepublish"],
  "preversion": ["check-cov"]
};


2. 자동으로 문서를 만들려면 아래와 같은 명령을 실행하면 된다.

메타 데이터에 대한 문서 자동화 명령

[binrang@binrang br-elec-component]$ gulp generate-metadata
[16:47:10] Using gulpfile ~/br-electrode-component/br-elec-component/gulpfile.js
[16:47:10] Starting 'generate-metadata'...
[16:47:12] Finished 'generate-metadata' after 1.39 s
[binrang@binrang br-elec-component]$

문서화 자동화 명령

[binrang@binrang br-elec-component]$ gulp generate-documentation
[16:59:53] Using gulpfile ~/br-electrode-component/br-elec-component/gulpfile.js
[16:59:53] Starting 'generate-documentation'...
[16:59:54] Finished 'generate-documentation' after 831 ms
[binrang@binrang br-elec-component]$ cat components.md 
#  (br-elec-component)
br-elec-component
## 
### Properties
 Property | Type | Description | Default |
 -------- | ---- | ----------- | ------- |
 *friend* | object |  | 
 *styleObj* | object |  | 
### import
```jsx
import  from "br-elec-component";
```
<hr/>

메타데이타와 문서화를 동시에 진행하는 명령

[binrang@binrang br-elec-component]$ gulp generate
[17:18:45] Using gulpfile ~/br-electrode-component/br-elec-component/gulpfile.js
[17:18:45] Starting 'generate'...
[17:18:45] Starting 'generate-metadata'...
[17:18:46] Finished 'generate-metadata' after 845 ms
[17:18:46] Starting 'generate-documentation'...
[17:18:47] Finished 'generate-documentation' after 833 ms
[17:18:47] Finished 'generate' after 1.69 s
[binrang@binrang br-elec-component]$