より良いエンジニアを目指して

記事を頻繁に書き直す性格なのでごめんなさい。

GitBookで設計書を書けないか

先日のDraw.ioを試したようにWordやExcelではない設計書を作成する旅をしています。

github.com

GitBookを試してみました。

npm init

npm install -g gitbook-cli

gitbook init

book.jsonを追加して以下のように記載します。

{
    "language": "ja"
}

編集

ページの編集

あとはmarkdownファイルでページを作成していくだけですね。

f:id:rimever:20190810213014p:plain

ページの作成についてはdocフォルダを切っていった方が綺麗に整理できそうです。

SUMMARY.md

SUMMARY.md は左サイドバーに対応します。

SUMMARY.mdに先ほど作成したページへのリンクを追加します。

* (要件定義書)[01_要件定義/要件定義書.md]

といった形です。

f:id:rimever:20190810212938p:plain

実行

ターミナルにて、以下を実行します。

gitbook serve

http://localhost:4000/ へアクセスします。

f:id:rimever:20190810212855p:plain

仕組みとしてはmarkdownをビルドしてhtmlを生成するようです。

さらにPlantUml

以下のプラグインを使えばPlantumlを組み合わせることができるようです。

github.com

umlpngに変換されて埋め込まれるようなのですが、なぜか参照できておらず、調査中です。

参考サイト

qiita.com

blog.kondoumh.com