Seoul.js 8.18 1st 밋업 대부분의 성숙하고 잘 알려진 프로젝트라고 하면 따라오는 것이 문서화입니다. 더불어 개발자들에게 고통과 번거러움을 동반하는 것 역시 문서화입니다. Flybook은 이러한 문서화의 고통을 해소 시켜보고자 시작한 Node 기반의 CLI 도구이고 이 발표에서는 Flybook을 이용해 손쉽게 문서화를 할 수 있는 방법들과 CI 툴과 연동하여 문서를 자동으로 생성하는 몇가지 편리한 활용법을 이야기하려고 합니다.

1. F L Y B O O K

2. @ R H I O K I M

3. P R E S E N T A T I O N

4. I N D E X
• Flybook Introduction
• How Flybook works
• How to use Flybook in your project
• How to integrate Flybook with Circle CI
• Roadmap

6. Haroopress
Haroopad
Flybook

10. docs
basic
- getting-started.md
- install.md
advanced
- github-gh-pages.md
- theme.md
examples
- syntax-highlight.md
flybook

11. flybookmarkdown gh-pages:github

12. import { renderToStaticMarkup } from ‘react-dom/server'
import React from ‘react’
$ flybook --help
Description
FlyBook is a simple utility to generate static website
that look like online manual.
Usage

13. npm install flybook --save-dev

14. $ flybook docs --outdir=out

15. “scripts”: {
“docs”: “flybook docs --outdir=out”
}
package.json
npm run docs

16. preparations

18. “scripts”: {
“deploy”: “gh-pages -d out”
}
npm install gh-pages --save-dev
package.json

20. push
webhook
build
push
gh-pages
your-id.github.io/flybook

21. jobs:
build:
docker:
- image: circleci/node:8
working_directory: ~/flybook
steps:
- checkout
- run:
name: run flybook
command: flybook docs —outdir=out
workflows:
version: 2
build:
jobs:
- build
.circleci/config.yml

22. x

23. R O A D M A P
F L Y … PRESENTATION?
F L Y … RESUME?
F L Y … API DOCS?