Skip to content

Update README.md

Update README.md #64

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [main]
# Allow one concurrent deployment
concurrency:
group: 'pages'
cancel-in-progress: true
permissions:
contents: read
pages: write
id-token: write
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Needed for git revision info
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Build project
run: npm run build
## Note that we do not publish the library to npm ##
## We only deploy the docs. We consider auto deploying the library ##
## as too risky given the fact that there are no full time maintainers ##
- name: Generate documentation
run: npm run docs
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs'
# Deployment job - only runs on main branch pushes
deploy:
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
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