GitHub Pages

NuxtアプリケーションをGitHub Pagesインフラストラクチャにデプロイします。

Nuxtは以下へのデプロイをサポートしていますGitHub Pages最小限の設定でデプロイすることをサポートしています。

GitHub Pagesは静的サイトのみをサポートしており、Nuxtはアプリケーションを静的HTMLファイルにプリレンダリングします。
カスタムドメインを使用している**いない**場合、ビルドステップでNUXT_APP_BASE_URLをリポジトリのスラッグに設定する必要があります。**例**: https://<user>.github.io/<repository>/の場合: NUXT_APP_BASE_URL=/<repository>/ npx nuxt build --preset github_pages

セットアップ

以下の手順に従ってくださいGitHub Pagesサイトを作成する.

デプロイメント

以下は、github_pagesプリセットを使用してサイトをGitHub PagesにデプロイするGitHub Actionsワークフローの例です。

.github/workflows/deploy.yml
# https://github.com/actions/deploy-pages#usage
name: Deploy to GitHub Pages
on:
  workflow_dispatch:
  push:
    branches:
      - main
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: corepack enable
      - uses: actions/setup-node@v4
        with:
          node-version: "20"
      # Pick your own package manager and build script
      - run: npm install
      - run: npx nuxt build --preset github_pages
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./.output/public
  # Deployment job
  deploy:
    # Add a dependency to the build job
    needs: build
    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source
    # Deploy to the github_pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    # Specify runner + deployment step
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
github-pagesデプロイプリセットの詳細については、**Nitroドキュメント**をご覧ください。