Help us understand the problem. What is going on with this article?

GitLab CIとmdbookで本を書いて公開する

More than 1 year has passed since last update.

mdbookはRust製のGitbookクローンです。

image.png

このように左に章立て、右に本文の形式のHTMLが出来ます。Rustのドキュメントの多くはmdbookで生成されているのでRustを書いていると良く見ますね。

以前の記事で紹介したように、図や数式(MathJax)を追加することができます
image.png

今回はこのmdbookで生成したHTMLをGitLabの機能であるGitLab CIを用いて自動的にデプロイするための設定を簡単に行うためのリポジトリを作ったので紹介します。

使い方

  1. https://gitlab.com/termoshtt/my-first-mdbook をGitLabでフォークする
  2. src/以下にあるMarkdownファイルに追記する
  3. GitLabにpushする

でHTTPSで生成されたbook形式のHTMLがホストされます。

  • Markdownでの数式の書き方は以前の記事を参考にしてください
  • URLはhttps://{username}.gitlab.com/{repository_name}になるはずです。
    • 実際には左側のSettings > Pagesのタブを見れば正しいリンクがあるはずです
  • 初回のデプロイではSSLの証明書の有効化に30分程度(?)かかるはずなので気をつけてください。

手元で生成結果を確認する

書いてる途中で確認するにはmdbookをインストールする必要があります。後述の方法でインストールしたのち、

mdbook build

book/ディレクトリ以下にHTMLが生成されます。

バイナリをダウンロードする

GitHubのmdbookのリポジトリのリリースのページでバイナリが配布されているのでそれを使います

https://github.com/rust-lang-nursery/mdBook/releases

tar/zipを解凍すると実行ファイルのmdbookが素ではいっているはずです

cargoでインストールする

Rustの開発環境を整える場合は

cargo install mdbook

で入ります。ただコンパイルはちょっと重めです。

ricos
FEMによる構造解析、機械学習の専門家集団。計算資源のクラウド提供もしています。
https://www.ricos.co.jp/
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした