メインコンテンツまでスキップ

マニュアルを公開するには

このページでは、annai（ソースコードからユーザー向けマニュアルを自動生成するツール）で生成したマニュアルを、Cloudflare Pages（Web サイトのホスティングサービス）へ公開します。

手順​

  1. Cloudflare の認証がまだの場合は、ターミナル（コマンドを入力する画面）で以下のコマンドを実行します。ブラウザが自動で開くので、アカウント情報を入力してログインします。すでに認証済みの場合は、この手順をスキップできます。

    npx wrangler login

  2. プロジェクトのルートフォルダにある annai.config.json（annai の設定ファイル、JSON（データ記述形式）で記述されています）を開き、cloudflare.projectName にプロジェクト名が入っているか確認します。

    {
      "cloudflare": {
        "projectName": "my-app-manual"
      }
    }

    このプロジェクト名が公開先の URL の一部になります。

  3. 以下のコマンドを実行して、マニュアルを公開します。

    annai deploy

  4. ターミナルに公開先の URL が表示されます。ブラウザでその URL を開き、マニュアルサイトが表示されることを確認します。

ここまでの手順が完了すると、マニュアルがインターネット上に公開され、URL を共有するだけで誰でも閲覧できる状態になります。

警告

「cloudflare.projectName が設定されていません」というメッセージが表示された場合は、annai.config.json の cloudflare.projectName にプロジェクト名を入力して保存します。 「Cloudflare Pages へのデプロイに失敗しました」というメッセージが表示された場合は、npx wrangler login で認証をやり直してから再度 annai deploy を実行します。

関連ページ​