Merge pull request #34 from st-tech/api-docs

chore: add api docs

Author: ssssota

.github/workflows/pages.yml

@@ -13,8 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup
-      - run: pnpm build
-        working-directory: demo
+      - run: pnpm pages
 
       - if: github.event_name == 'push'
         uses: actions/upload-pages-artifact@v3

demo/src/App.svelte

@@ -53,7 +53,8 @@
 <div class="grid grid-rows-[auto_1fr] h-screen divide-y">
   <header class="flex justify-between p-4">
     <h1 class="font-bold">universal-links-test demo</h1>
-    <div class="flex gap-2 items-center">
+    <div class="flex gap-4 items-center">
+      <a href="./docs/">API</a>
       <a
         href="http://github.com/st-tech/apple-app-site-association"
         target="_blank"

package.json

@@ -23,7 +23,10 @@
 		"clean": "node -e \"fs.rmSync('dist',{recursive:true,force:true})\"",
 		"prepare": "npm run clean && npm run build",
 		"fmt": "biome check --write .",
-		"check": "biome check ."
+		"check": "biome check .",
+		"pages": "pnpm demo && pnpm doc",
+		"doc": "typedoc --basePath ./ --titleLink 'https://st-tech.github.io/universal-links-test/' --out demo/dist/docs src",
+		"demo": "pnpm --dir demo build"
 	},
 	"keywords": [
 		"aasa",
@@ -42,6 +45,7 @@
 	"devDependencies": {
 		"@biomejs/biome": "^1.9.4",
 		"@types/node": "^22.10.2",
+		"typedoc": "^0.27.5",
 		"typescript": "^5.7.2",
 		"vitest": "^2.1.8"
 	}