ローカルビルドの方法

Antora の Quick Start Guide に従って、Node.js と Antora が利用できる状態を前提とします。 antora コマンドはローカルインストールの場合は npx antora として実行してください。

手順

  1. リポジトリをクローンする

    git clone git@github.com:tier4/mrm-design-documentation.git
  2. ビルドする

    cd mrm-design-documentation/antora_docs
    npx antora antora-local-playbook.yml
  3. ブラウザで確認する

    ビルド完了時に以下のログのように出力先が表示されます。リンク(file:///…​/index.html)を開いて確認してください。

    Site generation complete!
    Open file:///path/to/mrm-design-documentation/antora_docs/build/site/index.html in a browser to view your site.