Skip to content

Commit

Permalink
Add typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jdesrosiers committed Feb 10, 2025
1 parent 88b2223 commit 7af854b
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Deploy Documentation

on:
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: lts/*
- run: npm install
- run: npm run docs
- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v3
with:
path: './docs'
deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/deploy-pages@v4
id: deployment
1 change: 1 addition & 0 deletions .github/workflows/nodejs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ jobs:
- run: npm test
- run: npm run lint
- run: npm run type-check
- run: npm run docs
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
node_modules/
package-lock.json

docs/

scratch/
TODO*
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
"test": "vitest --watch=false",
"coverage": "vitest run --coverage",
"type-check": "tsc --noEmit",
"docs": "typedoc",
"prepack": "tsc --project tsconfig.build.json",
"postpack": "node ./bin/postpack.js"
},
Expand All @@ -44,6 +45,7 @@
"@typescript-eslint/parser": "*",
"eslint-import-resolver-typescript": "*",
"eslint-plugin-import": "*",
"typedoc": "^0.27.6",
"typescript-eslint": "*",
"undici": "^7.3.0",
"vitest": "*"
Expand Down

0 comments on commit 7af854b

Please sign in to comment.