Skip to content

Commit

Permalink
docs: Generate API doc with typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
szkiba committed Feb 22, 2024
1 parent e8b5348 commit c7e58f5
Show file tree
Hide file tree
Showing 7 changed files with 95 additions and 2,331 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Docs
on:
push:
branches: [master, feat-js-like-api]
paths:
- .github/workflows/docs.yml
- index.js
- index.d.ts
- tsconfig.json

jobs:
docs:
name: Docs
runs-on: ubuntu-latest

steps:
- name: Check out code
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Install bun
uses: oven-sh/setup-bun@v1
- name: Generate API doc
run: bun x typedoc
- name: Copy index.js
run: cp index.js build/docs/

- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: "build/docs"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/k6
*_skeleton.go
/build
/build
/node_modules
yarn.lock
Loading

0 comments on commit c7e58f5

Please sign in to comment.