gitbook

docker containerとか転がってるけど、まずは気持ちを新たに王道のインストールをして使い倒す。 いずれ docker container 化して、 nginx proxy のコンテナの後ろにドキュメントごとに設置したい。

• インストールはほぼコレ: http://takemikami.com/2017/02/14/gitbook.html

• package.json に scripts を書いておくと便利

  "scripts": {
      "dev": "gitbook serve",
      "build": "gitbook build",
      "pdf": "gitbook pdf",
      "lint": "textlint *.md `find articles -name '*.md'`"
  },
  

• 出力方法

  • 編集しながら確認できる web の起動:

    $ npm run dev
        #-> http://localhost:4000/ で閲覧可能
    

  • 静的 html の出力:

    $ npm run build
        #-> _book/ ディレクトリに全て生成される
    

plugin

• plugin のインストール

  $ ./node_modules/.bin/gitbook install
  

• PlantUMLのpluginは公式少し見ながら: https://www.npmjs.com/package/gitbook-plugin-uml

• Markdown 内での書き方例:

  - クライアント・サーバ間のシーケンス図
      ```uml
      @startuml
      client -> server: request
      server -> client: response
      @enduml
      　```
  - 次のシーケンス図
  ...
  

• mermaid も入れる: https://plugins.gitbook.com/plugin/mermaid

pdf

• PDF生成コマンド

  $ ./node_modules/.bin/gitbook pdf
      #-> book.pdf が生成される
  

• でてきたエラー

  • InstallRequiredError: "ebook-convert" is not installed. と言われたら、 calibre と ebook-convert を入れる必要がある

    npm install ebook-convert
    brew cask install calibre