chore: include prebuilt sample apps in tsky docs (#86)

Author: shuuji3

docs/.vitepress/config.mts

@@ -5,6 +5,7 @@ import typedocSidebar from '../api/typedoc-sidebar.json';
 export default defineConfig({
   title: 'tsky',
   description: 'A Bluesky API client for nimble apps and tools',
+  ignoreDeadLinks: [/\/examples\//],
   themeConfig: {
     nav: [
       { text: 'Home', link: '/' },

docs/examples.md

@@ -4,4 +4,4 @@ outline: deep
 
 # Examples
 
-TODO: Add examples here
+- [User profile](/examples/user-profile/){target="_self"}

docs/package.json

@@ -3,15 +3,21 @@
   "version": "1.0.0",
   "private": true,
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "predev": "typedoc",
     "dev": "vitepress dev",
     "prebuild": "typedoc",
     "build": "vitepress build",
+    "postbuild": "pnpm build:examples && pnpm copy-example-apps",
+    "build:examples": "pnpm --filter 'examples-*' build",
+    "copy-example-apps": "tsx scripts/copy-example-apps.ts",
     "preview": "vitepress preview",
     "test": "echo \"Error: no test specified\""
   },
   "devDependencies": {
+    "@types/node": "^22.13.10",
+    "tsx": "^4.19.2",
     "typedoc": "^0.27.1",
     "typedoc-plugin-markdown": "^4.3.0",
     "typedoc-vitepress-theme": "^1.1.0",

docs/scripts/copy-example-apps.ts

@@ -0,0 +1,10 @@
+import fs from 'node:fs/promises';
+
+const apps = await fs.readdir('../examples');
+
+for (const app of apps) {
+  console.log(`copying example app ${app} ...`);
+  fs.cp(`../examples/${app}/dist`, `./.vitepress/dist/examples/${app}`, {
+    recursive: true,
+  });
+}

docs/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "moduleDetection": "force",
+    "useDefineForClassFields": false,
+    "experimentalDecorators": true,
+    "baseUrl": ".",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "strict": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "noImplicitAny": true,
+    "noUnusedParameters": true,
+    "declaration": false,
+    "noEmit": true,
+    "outDir": "dist/",
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": true
+  },
+  "include": ["./scripts/**/*"],
+}

examples/user-profile/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "user-profile",
+  "name": "examples-user-profile",
   "private": true,
   "version": "0.0.0",
   "type": "module",
@@ -25,4 +25,4 @@
     "typescript-eslint": "^8.24.1",
     "vite": "^6.2.0"
   }
-}
+}

examples/user-profile/src/App.tsx

@@ -54,7 +54,7 @@ function App() {
             rel="noreferrer"
           >
             <img
-              src="/tsky-logo.png"
+              src="/examples/user-profile/tsky-logo.png"
               alt="tsky logo"
               className="size-9 min-w-9 rounded"
             />

examples/user-profile/vite.config.ts

@@ -5,4 +5,5 @@ import tailwindcss from '@tailwindcss/vite';
 // https://vite.dev/config/
 export default defineConfig({
   plugins: [react(), tailwindcss()],
+  base: '/examples/user-profile/',
 });

package.json

@@ -35,4 +35,4 @@
       "biome check --write --"
     ]
   }
-}
+}