Skip to content

Merge pull request #2 from theam/add_gh_pages #2

Merge pull request #2 from theam/add_gh_pages

Merge pull request #2 from theam/add_gh_pages #2

name: Publish documentation
on:
push:
branches:
- main
workflow_dispatch:
jobs:
deploy-docs:
name: Publish documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
path: docs-site
node-version: 18
cache: npm
cache-dependency-path: docs-site/package-lock.json
- name: Install dependencies
run: npm ci
working-directory: docs-site
- name: Build website
run: npm run build
working-directory: docs-site
# 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
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./docs-site/build
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com