flybook ( 마크다운파일 자동 문서화 )

 flybook 공식 사이트 : https://flybook.js.org/

음 마크다운 형식의 문서를 웹문서로 변환해 주는 것 같은데....

아직 더 파악해야 할듯...

아주 고마운 분이시다~~~마크다운으로 이렇게 자동 문서화를 해주시니~ ㅎㅎ

flybook 설치 ( nodejs 설치 안되어 있다면 설치해야 한다. )

npm install flybook --save-dev

markdown 파일을 만들 폴더 생성 ( 아래는 예제 )

- my-app이란 프로젝트에 docs 폴더 생성( readme.md 는 초기 화면 index성격을 띄기 때문에 반드시 필요한 파일이다. )

- advanced.md / basic.md 는 그냥 예제 파일이다. 이름은 사용자 맘대로~

docs
|____advanced.md
|____basic.md
|____readme.md

package.json 지정

- scripts 부분에 실행명령어를 docs라 일단 지정해 준다.

- 아래 docs명령어에 지정된 코드 내용

   ---> flybook 마크다운파일있는 폴더명 --outdir=html생성폴더명 --codeStyle=코드스타일

- codeStyle=monokai-sublime 이라 지정한 부분은 굳이 안써도 된다. 

   마크다운에서 <pre><code></code></pre> 라고 지정한 코드들을 스타일을 꾸며주는 역활을 한다. 

   https://highlightjs.org/   에 가보면 여러 스타일 있는데 지정하고 싶은 스타일명을 입력해 넣으면 된다. 

{
   .........중략...........
  "scripts": {
    "docs": "flybook docs --outdir=out --codeStyle=monokai-sublime"
  },
  .........중략...........
}

실행 

npm run docs