GitHub - rust-lang/mdBook: Create book from markdown files. Like Gitbook but implemented in Rust
Create book from markdown files. Like Gitbook but implemented in Rust - rust-lang/mdBook
https://github.com/rust-lang/mdBook
作ってみた
gh-pages
config.toml
base_url の設定にはまる
base_url の設定だけ探し回った。
gh-pages の url が https://ousttrue.github.io/cmake_book/
と root フォルダでは無いので必用。
book.toml
github
book.toml
github actions
mdBook Action - GitHub Marketplace
GitHub Actions for mdBook ⚡️ Setup mdBook quickly and build your site fast
https://github.com/marketplace/actions/mdbook-action
を参考にしたのだけど、 ちょっとはまった。
動かないとき、特に action として認識されていないときは全く手掛かりが無くて難儀した。
GitHub Actions のクイックスタート - GitHub Docs
GitHub Actions の機能を 5 分またはそれ以下で試すことができます。
https://docs.github.com/ja/actions/quickstart
は動いたので、これと違うところを見比べて勘でなおした。 よくわかっていない。
mdbook の SUMMARY.md
SUMMARY.md
にページ構成を先に記述して章立てを作ってから中身を記述していくのが面白い。
この仕組みが合うものは、 zola
より mdbook
の方がサクサク作れそう。
hugo
とかと違って各ページに frontmatter
が不要なので、
ページを足したり引いたりするする場合はこちらの方が使いやすい。
Scrapbox 上にあるメモを整理するかもしれない。
作った。
あと、 blender の addon 作成メモ
とか Unity のカスタムエディターメモ
とか作るかも。
mdbook を gh-pages で初期化する手順
github に repository を作って gh-pages に公開するところまで
- new repository
https://github.com/GITHUB_USER_NAME/MDBOOK_REPOSITORY_NAME
- git clone GIT_REPOSITORY
- cd GIT_REPOSITORY
- mdbook init
book.toml
- .github/workflows/gh-pages.yml
- git add .
- git commit -m init
- git push
- action が発動し、mdbook がビルドした book フォルダが gh-pages ブランチに push される
- github の settings - pages から gh-pages branch を選んで root を設定する
- しばらくすると
https://GITHUB_USER_NAME.github.io/MDBOOK_REPOSITORY_NAME/
が有効になる
- しばらくすると
初回にページが表示されるまで何回か push が要るかも。
- repo 作る
- gh-pages branch に push する
- 設定で gh-pages を有効にする
- 再度 push し action を発動させる。この辺でサイトが見れることを確認する
参考
o296.com
https://o296.com/e/mdbook_as_blog.html