GitBook によるドキュメント作成

GitBook は Markdown形式のファイルからドキュメントを作成するツールです.HTML形式,PDF形式,EPUB形式,MOBI形式を作成することができます.

ここでは HTML および PDF 形式のみ確認しています.

過去に以下記事を書きました.

それぞれメリット・デメリットがあります.今回の GitBook は最終的に PDF 出力が出来て,そこそこ体裁が整っているのが最大の魅力だと思います.

gitbook-cli

GitBook はクラウドサービスですが,GitBookの機能をコマンドラインから操作できるツール gitbook-cli があります.これを使用してオフラインでも GitBook を使ってドキュメントを作成します.

環境構築

Miniconda (Anaconda) を使って環境を構築します. まずは gitbook という仮想環境を作成します.

conda create -n gitbook
conda activate gitbook

gitbook-cli は Nodejs アプリなので,Nodejs をインストールします.

conda install nodejs

npm を使って gitbook-cli をインストールします.

$ npm install gitbook-cli -g
$ gitbook --version
CLI version: 2.3.2
GitBook version: 3.2.3

プロジェクトの作成

init コマンドで空のプロジェクトを作成できます.試しに example というプロジェクトを作成します.

$ mkdir example
$ cd example
$ gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished

README.mdSUMMARY.md ファイルが作成されます.README.md はトップページになります.

// README.md

# Introduction

SUMMARY.md には文書の構成を記述します.これはサイドバーに表示される構造になります.

// SUMMARY.md

# Summary

* [Introduction](README.md)

ビルド

HTML形式で出力するには build コマンドを使います.

$ gitbook build
info: 7 plugins are installed                       
info: 6 explicitly listed                           
info: loading plugin "highlight"... OK              
info: loading plugin "search"... OK                 
info: loading plugin "lunr"... OK                   
info: loading plugin "sharing"... OK                
info: loading plugin "fontsettings"... OK           
info: loading plugin "theme-default"... OK          
info: found 1 pages                                 
info: found 0 asset files                           
info: >> generation finished with success in 0.6s !

ビルドしたデータは _book フォルダに作成されます.このフォルダの中をデプロイすることで公開することができます.

また,serve コマンドを使うことで,ローカルでサーバーを起動して表示確認することができます.

$ gitbook serve
Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.6s !

Starting server ...
Serving book on http://localhost:4000

ブラウザで http://localhost:4000 を開いて確認します.

最初のgitbook画面
Fig. 1 最初のgitbook画面

results matching ""

    No results matching ""