markdownでドキュメント作成
TRANSCRIPT
Markdownで ドキュメント作成
Yasuyuki Fujikawa (@Y_Fujikawa)
Agenda
• Markdownとは？
• ドキュメントは、どう作る？
• ドキュメントを作成しよう
• ドキュメントをバージョン管理しよう
• ドキュメントをWebサービスで管理しよう
そもそもなぜこの話題？
• Web+DB pressもMarkdownで書かれているhttp://www.slideshare.net/inao/githubkaigi
• 「書籍を書く」わけじゃないが
せっかくなので、しっかりしたものを書けるようになっておきたい
• 便利そうなものがあったので、共有しよう！
Markdownとは？
Markdownとは？
• 文書を記述するためのマークアップ言語
• 元々はプレーンテキスト形式からHTMLへの変換用に開発された
長所
• 文書自体が可読性が高い
• 文法がシンプルのため、
ソフトウェア開発者以外でも扱いやすく習得しやすい
最近の使いどころ
• 最近のエディタには標準またはプラグインで書くことができる。
• 例Kobito, Atom, Sublime Text, MarsEditMarxi.co, Mou, MacDown
ドキュメントはどう作る？
1ページの作成だけなら エディタでOK
ドキュメントとなっては話が別
ドキュメント
• 画像を挿入しないといけない
• 複数ページになる
• レビューが必要となる可能性がある
• 結果的にOffice製品に頼らないといけない？
「プログラマ」としてMarkdownで書きたい
※自戒の意味も含め 今更、Wordなんて。。。
そこで、Gitbookですよ！
ドキュメントを作成しよう
インストールと初期設定
# 例のごとく、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 [email protected]:Y-Fujikawa/XXX.git$ git push orign master
# Pushされたか確認# https://github.com/Y-Fujikawa/XXX
これで共有できる
ドキュメントを Webサービスで管理しよう
便利なものには Webサービスあり
管理画面
実際に触ってみる ※Githubアカウントが あると簡単です
ありがとうございました