Skip to content

Commit 5af87a8

Browse files
committed
Setup typedoc
1 parent f010c17 commit 5af87a8

File tree

4 files changed

+125
-27
lines changed

4 files changed

+125
-27
lines changed

.github/typedoc.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Typedoc Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
jobs:
15+
version:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v5
20+
- name: Cache turbo build setup
21+
uses: actions/cache@v4
22+
with:
23+
path: .turbo
24+
key: ${{ runner.os }}-turbo-${{ github.sha }}
25+
restore-keys: |
26+
${{ runner.os }}-turbo-
27+
28+
- uses: oven-sh/setup-bun@v2
29+
- name: Install dependencies
30+
run: bun install --frozen-lockfile
31+
- name: Build
32+
run: bun run build
33+
- name: Lint
34+
run: bun run lint
35+
36+
# GitHub pages documentation
37+
- name: TypeDoc
38+
run: bun run typedoc
39+
- name: Setup Pages
40+
uses: actions/configure-pages@v5
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: "docs/"
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)