mdBook&GitHubPagesでのドキュメント公開Zennfof📖mdBook&GitHubPagesでのドキュメント公開2020/09/24に公開2022/10/08GitHubRustMarkdownmdbooktechmdBookとはRust製のGitBookライクなツールです。マークダウンで記述することができ、簡単にオンラインブックを作ることができます。RustのインストールmdBookを使うためにRustのパッケージ管理ツールであるCargoをインストールします。sh上記コマンドを実行するだけでインストールすることができます。Toolをインストールします。Rustup-init.exeをダウンロードし、実行します。以下のコマンドを実行するなどして、正常にインストールできているか確認しておきましょう。--versionmdBookのインストールCargoのインストールが終わったら、以下のコマンドでmdBookをインストールします。mdbookこちらも、以下のコマンドを実行するなどしてインストールできているか確認しましょう。--versionGitHub側の準備GitHubで、GitHubPages用のリポジトリ([ユーザー名].github.io、もしくは設定からGitHubPagesの設定をしたリポジトリ)、mdBookのプロジェクトをアップロードするためのリポジトリの2つを用意します。次に、リポジトリに登録するためのSSH鍵を用意します。keysにACTIONS_DEPLOY_KEYという名前で登録します。accessのチェックボックスにチェックを付けておきましょう。SecretsにこちらもACTIONS_DEPLOY_KEYという名前で登録します。これで、GitHub側の準備は終了です。ローカルでの準備まず、適当なフォルダを用意し、そのフォルダ内で以下のコマンドを実行します。initすると以下のようにファイルが生成されます。.gitignore(生成時に作成すると答えた場合)bookディレクトリにはビルドしたファイルが格納されます。srcディレクトリにはMarkdownファイル群を入れます。SUMMARY.mdに書いた中身がサイドメニューになります。serveを実行するとsrc以下のファイルを監視、変更があると自動で再ビルドをします。次に、GitHubActionsでの自動ビルドのセットアップをします。.github以下にファイルを追加します。追加後は以下のようなディレクトリ構成になります。.gitignore(生成時に作成すると答えた場合)作成後、main.yml、Dockerfileに以下のように記載してください。Actionsが実行され自動でGitHubPages用のリポジトリにHTML等のファイルがアップロードされます。おわりにmdBookとGitHubPagesを使うことで無料で簡単にオンラインブックを公開することができます。ドキュメントやブログなど、幅広く使うことができると思うので是非活用して見てください。fofバッジを贈って著者を応援しようバッジを受け取った著者にはZennから現金やAmazonギフトカードが還元されます。Proよくある質問LinksX(Twitter)GitHubメディアキットLegal利用規約プライバシーポリシ。