Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs website #43

Merged
merged 9 commits into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Publish
on:
release:
types: [published]
workflow_dispatch:
concurrency:
group: publish
cancel-in-progress: true
permissions: write-all
jobs:
publish-docs:
environment:
name: github-pages
url: ${{ steps.deploy-pages.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
cache: npm
- run: npm ci
- uses: actions/configure-pages@v3
- run: npm run build:docs
- uses: actions/upload-pages-artifact@v1
with:
path: docs/dist
- id: deploy-pages
uses: actions/deploy-pages@v2
18 changes: 9 additions & 9 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
name: Test
on:
push:
branches: [$default-branch]
branches: 'dev'
paths:
- src/**
- test/**
- "*.js"
- "*.ts"
- "*.json"
- '*.js'
- '*.ts'
- '*.json'
- .github/workflows/test.yml
pull_request:
branches: [$default-branch]
branches: 'dev'
paths:
- src/**
- test/**
- "*.js"
- "*.ts"
- "*.json"
- '*.js'
- '*.ts'
- '*.json'
- .github/workflows/test.yml
concurrency:
group: test-${{ github.ref }}
Expand All @@ -25,7 +25,7 @@ jobs:
test:
strategy:
matrix:
node-version: ["16", "18", "20"]
node-version: ['16', '18', '20']
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
docs/dist
node_modules/
.cache
.rpt2_cache
Expand Down
168 changes: 168 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"test": "vitest run",
"lint": "tsc --noEmit && eslint ./src --ext .ts",
"build": "rollup -c ./rollup.config.js",
"build:docs": "typedoc",
"release": "npm run lint && del dist && npm run build && np"
},
"repository": {
Expand Down Expand Up @@ -76,7 +77,8 @@
"rollup-plugin-dts": "^5.3.0",
"rollup-plugin-esbuild": "^5.0.0",
"typescript": "^5.0.4",
"vitest": "^0.31.1"
"vitest": "^0.31.1",
"typedoc": "^0.24.7"
},
"ava": {
"extensions": {
Expand Down
Loading