Merge pull request #43 from jcbhmr/add-docs

Add docs website

.github/workflows/publish.yml

@@ -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

.gitignore

@@ -1,3 +1,4 @@
+docs/dist
 node_modules/
 .cache
 .rpt2_cache

package.json

@@ -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": {
@@ -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": {

tsconfig.json

@@ -17,5 +17,10 @@
     "target": "es2019",
     "useDefineForClassFields": true
   },
-  "include": ["src/**/*", "test/**/*"]
+  "include": ["src/**/*", "test/**/*"],
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs/dist",
+    "skipErrorChecking": true
+  }
 }