Skip to content

docs: cleanup features list in README.md (#368) #61

docs: cleanup features list in README.md (#368)

docs: cleanup features list in README.md (#368) #61

Workflow file for this run

name: Deploy TypeDoc site to Pages
on:
push:
branches: [main]
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:
# Build job
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: latest
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build documentation
run: npm run docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/typedoc
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4