Skip to content

Commit 5b7af3f

Browse files
committed
add action and configuration for typedoc
1 parent 3c4b5a8 commit 5b7af3f

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

.github/workflows/docs.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- feature/tsdoc
7+
8+
jobs:
9+
docs:
10+
runs-on: ubuntu-latest
11+
name: Generate Code Docs
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- uses: pnpm/action-setup@v4
17+
name: Install pnpm
18+
with:
19+
version: 10
20+
run_install: false
21+
22+
- name: Install packages
23+
run: pnpm i
24+
25+
- name: Build docs
26+
run: pnpm typedoc
27+
28+
- name: Upload docs to GitHub Pages
29+
uses: peaceiris/actions-gh-pages@v4
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
publish_dir: ./docs

tsconfig/docs.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": "./mjs.json",
3+
"exclude": ["./components", "./mjs", "./cjs", "./testing"]
4+
}

typedoc.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"entryPoints": ["ts"],
3+
"tsconfig": "tsconfig/docs.json",
4+
"excludeNotDocumented": true,
5+
"includeVersion": false,
6+
"plugin": [],
7+
"entryPointStrategy": "expand"
8+
}
9+

0 commit comments

Comments
 (0)