docs.yml

name: Docs

# Temporarily disable the workflow except when manually triggered
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch
on: workflow_dispatch

# on:
#   push:
#     branches:
#       - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v4
        with:
          # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
          persist-credentials: false

      - name: Install npm dependencies 🛠
        run: yarn

      - name: Build 🔧
        run: yarn docs

      - name: NoJekyll 🎃
        run: touch docs/.nojekyll

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@releases/v3
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: docs