Skip to content

Commit

Permalink
Setup typedoc to generate API reference docs (sergiodxa#356)
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiodxa authored May 3, 2024
1 parent d71116c commit 6784f93
Show file tree
Hide file tree
Showing 8 changed files with 334 additions and 196 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Deploy Documentation

on:
push:
branches: ["main"]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "docs"
cancel-in-progress: false

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: oven-sh/setup-bun@v1
- run: bun install ----frozen-lockfile && bunx typedoc
- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v3
with:
path: "./docs"
- uses: actions/deploy-pages@v4
id: deployment
11 changes: 6 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
*.log
.DS_Store
node_modules

/build
/coverage
/coverage
/docs
/node_modules

*.log
.DS_Store
Binary file modified bun.lockb
Binary file not shown.
Loading

0 comments on commit 6784f93

Please sign in to comment.