Skip to content

docs: add gh-pages

docs: add gh-pages #4

Workflow file for this run

name: Documentation
on:
push:
branches: [main]
paths:
- docs/**
pull_request:
branches: [main]
paths:
- docs/**
permissions:
contents: write
jobs:
deploy:
name: Deploy Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: pnpm/action-setup@v4
with:
version: latest
- uses: actions/setup-node@v4
with:
node-version: lts/*
cache: pnpm
- name: Install & build
working-directory: docs
run: |
pnpm i
pnpm build
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./docs/build
# Assign commit authorship to the official GH-Actions bot
user_name: github-actions[bot]
user_email: github-actions[bot]@users.noreply.github.com