Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Workflow for deploying docs static content to GitHub Pages.
name: Deploy static docs to Pages

on:
release:
types: [published]
# Allows you to run this workflow manually from the Actions tab.
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run
# in-progress and latest queued. However, do NOT cancel in-progress runs as we
# want to allow these production deployments to complete.
concurrency:
group: 'pages'
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying.
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Node.js
uses: actions/setup-node@v4
with:
node-version: 22

- name: npm ci
run: npm ci --foreground-scripts

- name: npm run docs
run: npm run docs

# - name: Setup Pages
# uses: actions/configure-pages@v5

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/lib

## Others.
/docs
/coverage
/.cache

1 change: 0 additions & 1 deletion docs/.nojekyll

This file was deleted.

21 changes: 0 additions & 21 deletions docs/assets/custom.css

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/hierarchy.js

This file was deleted.

92 changes: 0 additions & 92 deletions docs/assets/highlight.css

This file was deleted.

18 changes: 0 additions & 18 deletions docs/assets/icons.js

This file was deleted.

Loading