문서화에 날개를 달아주는 flybook cli
TRANSCRIPT
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 Circle CI
• Roadmap
Haroopress
Haroopad
Flybook
docs basic - getting-started.md - install.md advanced - github-gh-pages.md - theme.md examples - syntax-highlight.md
flybook
flybookmarkdown gh-pages:github
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 $ flybook <outdir> [options]
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 command: flybook docs —outdir=out workflows: version: 2 build: jobs: - build
.circleci/config.yml
x
R O A D M A P
F L Y … PRESENTATION?F L Y … RESUME?
F L Y … API DOCS?