Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
F L Y B O O K
@ R H I O K I M
P R E S E N T A T I O N
I N D E X
• Flybook Introduction
• How Flybook works
• How to use Flybook in your project
• How to integrate Flybook with ...
Haroopress
Haroopad
Flybook
docs
basic
- getting-started.md
- install.md
advanced
- github-gh-pages.md
- theme.md
examples
- syntax-highlight.md
flybo...
flybookmarkdown gh-pages:github
import { renderToStaticMarkup } from ‘react-dom/server'
import React from ‘react’
$ flybook --help



Description
FlyBook ...
npm install flybook --save-dev
$ flybook docs --outdir=out
“scripts”: {
“docs”: “flybook docs --outdir=out”

}
package.json
npm run docs
preparations
“scripts”: {
“deploy”: “gh-pages -d out”

}
npm install gh-pages --save-dev
package.json
push
webhook
build
push
gh-pages
your-id.github.io/flybook
jobs:
build:
docker:
- image: circleci/node:8
working_directory: ~/flybook
steps:
- checkout
- run:
name: run flybook
comm...
x
R O A D M A P
F L Y … PRESENTATION?
F L Y … RESUME?
F L Y … API DOCS?
문서화에 날개를 달아주는 Flybook CLI
문서화에 날개를 달아주는 Flybook CLI
문서화에 날개를 달아주는 Flybook CLI
문서화에 날개를 달아주는 Flybook CLI
문서화에 날개를 달아주는 Flybook CLI
문서화에 날개를 달아주는 Flybook CLI
Upcoming SlideShare
Loading in …5
×

문서화에 날개를 달아주는 Flybook CLI

2,171 views

Published on

Seoul.js 8.18 1st 밋업
대부분의 성숙하고 잘 알려진 프로젝트라고 하면 따라오는 것이 문서화입니다. 더불어 개발자들에게 고통과 번거러움을 동반하는 것 역시 문서화입니다.

Flybook은 이러한 문서화의 고통을 해소 시켜보고자 시작한 Node 기반의 CLI 도구이고 이 발표에서는 Flybook을 이용해 손쉽게 문서화를 할 수 있는 방법들과 CI 툴과 연동하여 문서를 자동으로 생성하는 몇가지 편리한 활용법을 이야기하려고 합니다.

Published in: Software
  • Hello! Get Your Professional Job-Winning Resume Here - Check our website! https://vk.cc/818RFv
       Reply 
    Are you sure you want to  Yes  No
    Your message goes here

문서화에 날개를 달아주는 Flybook CLI

  1. 1. F L Y B O O K
  2. 2. @ R H I O K I M
  3. 3. P R E S E N T A T I O N
  4. 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
  5. 5. Haroopress Haroopad Flybook
  6. 6. docs basic - getting-started.md - install.md advanced - github-gh-pages.md - theme.md examples - syntax-highlight.md flybook
  7. 7. flybookmarkdown gh-pages:github
  8. 8. 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
  9. 9. npm install flybook --save-dev
  10. 10. $ flybook docs --outdir=out
  11. 11. “scripts”: { “docs”: “flybook docs --outdir=out”
 } package.json npm run docs
  12. 12. preparations
  13. 13. “scripts”: { “deploy”: “gh-pages -d out”
 } npm install gh-pages --save-dev package.json
  14. 14. push webhook build push gh-pages your-id.github.io/flybook
  15. 15. 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
  16. 16. x
  17. 17. R O A D M A P F L Y … PRESENTATION? F L Y … RESUME? F L Y … API DOCS?

×