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