Works by

プログラミング等IT技術関連でメモする

【Document】Gitbookでイカしたドキュメントを作る

Gitbookとは

Gitbookは、Gitでの管理を意識したMarkdown記述式のドキュメンテーションツールです。
見栄えの良いドキュメントを簡単に作成・公開することができます。


f:id:rennnosukesann:20180223213638p:plain

GitbookではGitによってバージョン管理を行うことができます。
ソースコードのバージョン管理のようにGitでドキュメント管理用のリポジトリをローカル、およびリモートに作成でき、リモートに置かれたドキュメントは整形された形で外部に公開することができます。

Usage

Gitbook公式)はGitbook用ドキュメントのリモートリポジトリとなっており、すぐにGitbook用リポジトリを作成することができます。

1. アカウントを作成する

Gitbook公式のトップページにユーザ名・メールアドレス・パスワードを入力する欄があるので、各々入力して "Sign up for Gitbook" をクリック。

f:id:rennnosukesann:20180223214834p:plain

Sign up に成功すると以下のようなメッセージが出るので、入力したメールアドレスのメールボックスを確認。

f:id:rennnosukesann:20180223215031p:plain

するとGitbookからメールが届いているので、"Confirm email address" ボタンをクリック。

f:id:rennnosukesann:20180223215245p:plain

これで、アカウントは作成完了です。

2. リポジトリを作成する

次にリポジトリを作るため、右上の "New+" ボタンをクリックします。

f:id:rennnosukesann:20180223220116p:plain

作成するドキュメントの種類を決めます。
ドキュメントの種類は3つありますが、あくまでフォーマットなので後から修正できます。
今回は "Book & Manual" を選択します。
リポジトリ名と説明を入れたら、右下の "Create Book" をクリック。

f:id:rennnosukesann:20180223220044p:plain

これでリポジトリ作成完了です!

f:id:rennnosukesann:20180223220433p:plain

3. ドキュメントを作成する

作成したリポジトリの画面で、 "Edit your book" をクリック。

f:id:rennnosukesann:20180223221652p:plain

すると編集画面に遷移します。
新しいドキュメントを作ったり、既存のドキュメントを編集したりできます。
編集が完了したら右上の "publish" をクリックすると、リポジトリに編集結果が反映されます。

f:id:rennnosukesann:20180223222122p:plain

4. 作成したドキュメントを見る

Gitbookのアカウントホームページから、閲覧したいドキュメントのリポジトリのプルダウンをクリックし"Read"を選択。

f:id:rennnosukesann:20180223222457p:plain

すると現在公開されている状態のBookを閲覧することができます。

f:id:rennnosukesann:20180223222530p:plain


いかがだったでしょうか。
Gitbookはマテリアルデザインを踏襲したスッキリとした見た目なので、
見心地の良いドキュメントを作成することができると思います。

ブラウザ上でも十分編集可能ですが、ローカルのエディタを使いたいという方は
ローカルにGitbookをインストールするやり方がおすすめです。
こちらについても後ほど紹介しようと思います。