Gitbook

• mdwikiも良いが、シーケンス図がより綺麗

参考

• mermaid.jsが素晴らしいけどなかなか使ってる人見かけないので実例晒す(追記あり) - Qiita
• 「mermaid.js」が簡単に試せるMarkdownエディタ「Haroopad」 | You Look Too Cool
• mermaid live editor
• mermaid docs
  • syntax

Gitbook を dockerで動かす

• https://github.com/HeRoMo/gitbook-template

mkdir gitbook html

init

wget https://codeload.github.com/HeRoMo/gitbook-template/zip/master
unzip master
cd gitbook-template-master

init

docker-compose run --rm gitbook init

docker-compose up -d

sudo chown -R $USER gitbook

1分ほど待つ

• http://localhost:4000

目次の作成

• gitbook

# Summary
 
This is the summary of my book.
 
* [section 1](section1/README.md)
    * [example 1](section1/example1.md)
    * [example 2](section1/example2.md)
* [section 2](section2/README.md)
    * [example 1](section2/example1.md)

gitbook init

• 不足しているファイルを自動作成してくれる
  • section1/README.md
  • section1/example1.md
  • section1/example2.md
  • section2/README.md
  • section2/example1.md

CSSを変更

styles/website.css

h1 {
    text-align:center;
}

h2 {
    margin: 1.3em 0 .7em 0;
    background-color: #EEE;
    text-shadow: 0 1px 0 rgba(255, 255, 255, 0.6);
    line-height: 30px;
}

h3 {
    margin: 1.3em 0 .7em;
    border-bottom: solid 1px #d9d9d9;
    line-height: 1.4;
}

a {
    color: #117ec6;
    text-decoration: none;
    border-bottom: none;
}

• webサーバを再立ち上げで反映される

Haroopad

• windows, linux, mac用エディタ。主にmermaid書式の編集に用いる。
• mermaid記法対応(図が書ける)
• viキーバインド対応

あと一歩のところは、以下でmermaid書式と認識しない。

{% mermaid %}
...
{% endmermaid %}