Zenn
😀

GitBookまとめ

2019/01/29に公開
GitBook
tech

GitBookと類似ソフトウェアの比較

<blockquote class="twitter-tweet" data-lang="ja"><p lang="ja" dir="ltr">Google トレンドで「Gitbook, Penflip, Leanpub, Sphinx, <a href="https://t.co/G5D9oTUiWU">https://t.co/G5D9oTUiWU</a>」の 人気度の動向 を見る - <a href="https://t.co/ESo9wwU1I0">https://t.co/ESo9wwU1I0</a></p>— kannkyo (@kannkyoshi) <a href="https://twitter.com/kannkyoshi/status/1089923677821427712?ref_src=twsrc^tfw">2019年1月28日</a></blockquote>
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

<blockquote class="twitter-tweet" data-lang="ja"><p lang="ja" dir="ltr">Google トレンドで「Gitbook, Penflip, Leanpub, Sphinx, Pandoc」の 地域で比較した内訳 を見る - <a href="https://t.co/vd3mQwn8AW">https://t.co/vd3mQwn8AW</a></p>— kannkyo (@kannkyoshi) <a href="https://twitter.com/kannkyoshi/status/1089924149936410624?ref_src=twsrc^tfw">2019年1月28日</a></blockquote>
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

GitBookインストール

事前準備

GitBookが使っているnpmを初期化。

npm init

インストール

プロジェクト毎にインストールする場合

npm install --save gitbook-cli

グローバルにインストールする場合

npm install -g gitbook-cli

GitBookコマンド

初期化

git init

文書生成

git build

文書確認

git serve

プラグインインストール

  1. GitBook Pluginsでプラグインを検索。
  2. book.jsonにインストールしたいプラグイン名を追記。
  3. インストールコマンドを実行。
book.json
{
  "plugins": [
    "puml"
  ]
}

git install

ファイル生成

gitbook pdf ./ ./mybook.pdf

GitBookヘルプ

ヘルプページ

https://toolchain.gitbook.com/

コマンドライン上のヘルプ

gitbook --helpでヘルプが出てくるが、明らかに足りない・・・。

$ gitbook --help
  Usage: gitbook [options] [command]


  Options:

    -v, --gitbook [version]  specify GitBook version to use
    -d, --debug              enable verbose error
    -V, --version            Display running versions of gitbook and gitbook-cli
    -h, --help               output usage information


  Commands:

    ls                        List versions installed locally
    current                   Display currently activated version
    ls-remote                 List remote versions available for install
    fetch [version]           Download and install a <version>
    alias [folder] [version]  Set an alias named <version> pointing to <folder>
    uninstall [version]       Uninstall a version
    update [tag]              Update to the latest version of GitBook
    help                      List commands for GitBook
    *                         run a command with a specific gitbook version
$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

非推奨らしい・・・

GitBookのGitHubサイトをよくよく読むと非推奨と書いてある・・・。

warning Deprecation warning:
As the efforts of the GitBook team are focused on the GitBook.com platform, the CLI is no longer under active development.
All content supported by the CLI are mostly supported by our GitBook.com / GitHub integration.
Content hosted on the legacy.gitbook.com will continue working until further notice. For differences with the new vesion, check out our documentation.

by https://github.com/GitbookIO/gitbook

Discussion