狠狠撸

狠狠撸Share a Scribd company logo
Markdownで
ドキュメント作成
Yasuyuki Fujikawa (@Y_Fujikawa)
Agenda
? 惭补谤办诲辞飞苍とは?
? ドキュメントは、どう作る?
? ドキュメントを作成しよう
? ドキュメントをバージョン管理しよう
? ドキュメントをWebサービスで管理しよう
そもそもなぜこの話題?
? Web+DB pressもMarkdownで書かれている?
http://www.slideshare.net/inao/githubkaigi
? 「書籍を書く」わけじゃないが?
せっかくなので、しっかりしたものを?
書けるようになっておきたい
? 便利そうなものがあったので、共有しよう!
惭补谤办诲辞飞苍とは?
惭补谤办诲辞飞苍とは?
? 文書を記述するためのマークアップ言語
? 元々はプレーンテキスト形式から?
HTMLへの変換用に開発された
長所
? 文書自体が可読性が高い
? 文法がシンプルのため、?
ソフトウェア開発者以外でも?
扱いやすく習得しやすい
最近の使いどころ
? 最近のエディタには標準?
またはプラグインで書くことができる。
? 例?
Kobito, Atom, Sublime Text, MarsEdit?
Marxi.co, Mou, MacDown
ドキュメントは?
どう作る?
1ページの作成だけなら?
エディタでOK
ドキュメントとなっては?
話が別
ドキュメント
? 画像を挿入しないといけない
? 複数ページになる
? レビューが必要となる可能性がある
? 結果的にOf?ce製品に頼らないといけない?
「プログラマ」として?
Markdownで書きたい
※自戒の意味も含め
今更、Wordなんて。。。
そこで、骋颈迟产辞辞办ですよ!
ドキュメントを作成しよう
インストールと初期設定
# 例のごとく、Mac前提です。ごめんなさい!
# nodeをインストール(されている場合、スキップ)
$ brew install node
# gitbook-cliをインストール
$ npm install -g gitbook-cli
# 任意の箇所にドキュメントフォルダを作成
$ mkdir ~/Documents/workspace/gitbook-sample
# 初期化
$ cd gitbook-sample; gitbook init
閲覧可能にする
$ gitbook build
# サーバーを起動:Port 4000 使うので注意
$ gitbook serve
# ここまでできたら、少しドキュメントを作成します。
$ touch chapter1.md
$ vi chapter1.md # 適当なものを書いてください。
$ vi SUMMARY.md
# 以下の文章を追記
# * [はじめに](chapter1.md)
使ってみた結果
? 見た目は素晴らしい
? 日本語検索できない
? なぜか、SNSのシェアボタンがある
? わざわざ、ローカルサーバーを?
立ち上げないといけない
ドキュメントを
バージョン管理しよう
バージョン管理
$ git init
# GitHubにリポジトリを作って
$ git remote add origin git@github.com:Y-Fujikawa/XXX.git
$ git push orign master
# Pushされたか確認
# https://github.com/Y-Fujikawa/XXX
これで共有できる
ドキュメントを
Webサービスで管理しよう
便利なものには
Webサービスあり
https://www.gitbook.com
https://www.gitbook.com/book/y-fujikawa/how-to-git/details
管理画面
実際に触ってみる
※Githubアカウントが
あると簡単です
ありがとうございました

More Related Content

惭补谤办诲辞飞苍て?ト?キュメント作成