Skip to content

Upgrade docs: dark theme, markdown rendering, syntax highlighting #5

Upgrade docs: dark theme, markdown rendering, syntax highlighting

Upgrade docs: dark theme, markdown rendering, syntax highlighting #5

Workflow file for this run

name: Documentation
on:
push:
branches: [master, main]
paths:
- 'docs/**'
- 'README.md'
- 'src/**'
permissions:
contents: read
pages: write
id-token: write
jobs:
build-docs:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- name: Install dependencies
run: npm install
- name: Generate API documentation
run: npm run docs --if-present
- name: Upload documentation artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs
deploy-docs:
name: Deploy Documentation
needs: build-docs
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
continue-on-error: true
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
continue-on-error: true