経緯
-
Githubを使ってドキュメント管理がしたかった。
- リポジトリ内にてドキュメントのバージョン管理を行う
- GitHubPagesでその内容が見れるようにしたい
- gitbookがいい感じなのでそれを使いたい。
-
ブランチを切って、そこにドキュメントを上げることで、GithubPagesにリポジトリ単位でURL指定をすると、見ることができる。
(例) https://sample.github.io/sampleRepository- ブランチを切ってあげなければならない、上げるコマンドが若干複雑(怠惰)
- Githubにてコードと同じリポジトリ内で、ブランチを切らずにバージョン管理ができないものか。。。
手順
そもそも今は、わざわざbranch切らなくても、masterやmaster/branch選択できるようになった模様。(参考を参照。)
⇒ じゃあそれ使ってみよう!
1. githubにてリポジトリを作成する
=> Githubに新規リポジトリを追加を参照
2. gitbookを作成する
1. リポジトリに移動する
C:>chdir sampleProject
2. "docs"フォルダを作る(これがgitbookをデプロイするフォルダになる)
C:\sampleProject>mkdir docs
3. docsフォルダに移動する
C:\sampleProject>chdir docs
4. gitbookを管理するフォルダを作る
C:\sampleProject\docs>mkdir gitbookFolder
5. gitbookを管理するフォルダに移動する
C:\sampleProject\docs>chdir gitbookFolder
6. gitbookを初期化する
C:\sampleProject\docs\gitbookFolder>gitbook init
7. gitbookをいろいろいじった後、ビルドする(HTMLに変換する)
C:\sampleProject\docs\gitbookFolder>gitbook build
8. _bookフォルダに展開されたHTML、静的ファイルをdocsフォルダ(親フォルダ)にコピーする
C:\sampleProject\docs\gitbookFolder>xcopy _book ..\ /s/e/i
結果こうなる。
C:\sampleProject\docs\gitbookFolder>tree C:\sampleProject /f
C:.
│ index.html
└─docs
│ index.html
│ search_index.json
├─gitbook
│ ├─fonts
│ │ └─fontawesome
│ ├─gitbook-plugin-fontsettings
│ ├─gitbook-plugin-highlight
│ ├─gitbook-plugin-lunr
│ ├─gitbook-plugin-search
│ ├─gitbook-plugin-sharing
│ └─images
└─gitbookFolder
│ README.md
│ SUMMARY.md
└─_book
│ index.html
│ search_index.json
└─gitbook
├─fonts
│ └─fontawesome
├─gitbook-plugin-fontsettings
├─gitbook-plugin-highlight
├─gitbook-plugin-lunr
├─gitbook-plugin-search
├─gitbook-plugin-sharing
└─images
この状態でgitコミット
C:\sampleProject\docs\gitbookFolder>chdir C:\sampleProject
C:\sampleProject>git add *
C:\sampleProject>git commit -m "make gitbook"
C:\sampleProject>git push origin master
3. github側の設定でgitbookの読み取り先を変更する
2. 開いてみる。(https://ユーザー名.github.io/リポジトリ名)
4. その後
その後は、7.以降を繰り返せばOK.
※ もっといいフォルダの切り方はあるかもしれないです。その辺は各自の工夫に任せます。(自分的にはこの構成が好きです)