gitbookを使ってドキュメント作成

gitbookはgitで管理しているドキュメントを簡単にHTMLやPDF、EPUBに変換するサービスです。 基本的にはMarkdown記法のドキュメントをコマンドラインで変換します。 gitbookコマンドはNodo.jsで実現されています。

Markdownからドキュメント化するものにはPandocなどもありますが、どれが良いというのは特にありません。 どれを使うかは好みで良いのではないでしょうか？

改定履歴

インストール

次の手順でインストールする。

$ sudo apt install nodejs npm
$ sudo npm update
$ sudo npm install gitbook-cli -g

SNSメニューの非表示

SNSなどのメニューを出さないようにするためにbook.jsonを作成しインストールコマンドを実行する。

{
    "plugins": ["-sharing","hide-published-with"],
    "language": "ja"
}

インストールコマンドの実行

book.jsonを作成した場合はinstallコマンドを実行する。

$ gitbook install

スタイルの変更

スタイルを変更する場合、stylesフォルダを作成してCSSファイルを置く。

$ mkdir styles

作成するCSSファイルは次の3つです。

• website.css
• pdf.css
• epub.css

内容は次のように記載する。

h1 { 
    border-bottom: 2px solid #000; 
    padding-bottom:3px;
    }

ホームページ作成

$ gitbook build

PDFの作成

$ gitbook pdf

目次の作成

目次はSUMMARY.mdで作成する。

# Summary

* [Introduction](README.md)

# Summary

## 序文

* [この資料について](README.md)
  * [対象読者](README.md#対象読者)
  * [PDFの作成](README.md#PDFの作成)

## 本文

* [1. ほげほげ](contents/body-1.md)
* [2. ほげほげ](contents/body-2.md)
* [3. ほげほげ](contents/body-3.md)

## 結文

* [おわりに](contents/postscript.md)

更新

SUMMARY.mdを更新したらinitコマンドを実行する。

$ gitbook init

エラー

下記のエラーが発生した場合はinitかinstallコマンドを実行してみると解消される場合がある。

Error: ENOENT: no such file or directory, stat '/home/hoge/bitbook/_book/gitbook/gitbook-plugin-fontsettings/fontsettings.js'

Error: ENOENT: no such file or directory, stat '/home/hoge/bitbook/_book/gitbook/gitbook-plugin-lunr/lunr.min.js'