Skip to content

Merge pull request #5 from BlocksHub/docs/typedoc_to_gh_pages #1

Merge pull request #5 from BlocksHub/docs/typedoc_to_gh_pages

Merge pull request #5 from BlocksHub/docs/typedoc_to_gh_pages #1

Workflow file for this run

name: Generate docs
on:
push:
branches:
- "main"
workflow_dispatch:
jobs:
publish-docs:
permissions:
id-token: write
pages: write
environment:
name: "github-pages"
url: "${{ steps.deployment.outputs.page_url }}"
runs-on: "ubuntu-latest"
steps:
- uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm ci
- name: Build documentation
run: npm run docs
- name: Upload documentation
uses: "actions/upload-pages-artifact@v2"
with:
path: "docs/"
- name: Deploy to GitHub Pages
uses: "actions/deploy-pages@v2"