feat: use typedoc for api docs page (#51)

shuuji3 · anbraten · taskylizard · web-flow · commit b9c7c9e010f8 · 2025-01-25T14:11:05.000+09:00
Co-authored-by: Anbraten &lt;anton@ju60.de&gt;
Co-authored-by: taskylizard &lt;75871323+taskylizard@users.noreply.github.com&gt;
Co-authored-by: Anbraten &lt;6918444+anbraten@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <img src=".github/assets/tsky-logo.png" width="200" height="200">
+  <img src="https://raw.githubusercontent.com/tsky-dev/tsky/refs/heads/main/.github/assets/tsky-logo.png" width="200" height="200">
 </p>
 
 <h1 align="center">tsky</h1>
@@ -82,4 +82,4 @@ If you want to contribute to this project, please read the [CONTRIBUTING.md](CON
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/tsky-dev/tsky/blob/main/LICENSE) file for details.
diff --git a/biome.json b/biome.json
@@ -17,7 +17,8 @@
       "node_modules",
       "package.json",
       "tsconfig.json",
-      "packages/lexicons/src/lib/lexicons.ts"
+      "packages/lexicons/src/lib/lexicons.ts",
+      "docs/api/"
     ]
   },
   "linter": {
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,3 @@
 .vitepress/cache/
 .vitepress/dist/
+api/
diff --git a/docs/.nvmrc b/docs/.nvmrc
@@ -0,0 +1 @@
+22
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -1,4 +1,5 @@
 import { defineConfig } from 'vitepress';
+import typedocSidebar from '../api/typedoc-sidebar.json';
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -12,15 +13,7 @@ export default defineConfig({
 
     sidebar: [
       { text: 'Getting Started', link: '/getting-started' },
-      {
-        text: 'API Reference',
-        link: '/api',
-        items: [
-          { text: 'new Tsky', link: '/api#tsky' },
-          { text: 'tsky.profile', link: '/api#profile' },
-          { text: 'tsky.typeahead', link: '/api#typeahead' },
-        ],
-      },
+      { text: 'API', items: typedocSidebar },
       {
         text: 'Examples',
         link: '/examples',
diff --git a/docs/api.md b/docs/api.md
diff --git a/docs/index.md b/docs/index.md
@@ -4,6 +4,7 @@ layout: home
 
 hero:
   name: "tsky"
+  image: https://raw.githubusercontent.com/tsky-dev/tsky/refs/heads/main/.github/assets/tsky-logo.png
   text: "A Bluesky API client for nimble apps and tools"
   tagline: A Bluesky API client for nimble apps and tools
   actions:
diff --git a/docs/package.json b/docs/package.json
@@ -1,15 +1,20 @@
-{
-  "name": "@tsky/docs",
-  "version": "1.0.0",
-  "private": true,
-  "main": "index.js",
-  "scripts": {
-    "dev": "vitepress dev",
-    "build": "vitepress build",
-    "preview": "vitepress preview",
-    "test": "echo \"Error: no test specified\""
-  },
-  "devDependencies": {
-    "vitepress": "^1.5.0"
-  }
-}
+{
+  "name": "@tsky/docs",
+  "version": "1.0.0",
+  "private": true,
+  "main": "index.js",
+  "scripts": {
+    "predev": "typedoc",
+    "dev": "vitepress dev",
+    "prebuild": "typedoc",
+    "build": "vitepress build",
+    "preview": "vitepress preview",
+    "test": "echo \"Error: no test specified\""
+  },
+  "devDependencies": {
+    "typedoc": "^0.27.1",
+    "typedoc-plugin-markdown": "^4.3.0",
+    "typedoc-vitepress-theme": "^1.1.0",
+    "vitepress": "^1.5.0"
+  }
+}
diff --git a/docs/typedoc.json b/docs/typedoc.json
@@ -0,0 +1,29 @@
+{
+  "$schema": "https://typedoc-plugin-markdown.org/schema.json",
+  "entryPoints": ["../packages/client"],
+  "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
+  "name": "Packages Example",
+  "entryPointStrategy": "packages",
+  "packageOptions": {
+    "includeVersion": true,
+    "entryPoints": ["src/*.ts"]
+  },
+  "basePath": "../packages/client/src",
+  "readme": "none",
+  "entryFileName": "index.md",
+  "mergeReadme": true,
+  "indexFormat": "table",
+  "useCodeBlocks": true,
+  "textContentMappings": {
+    "title.indexPage": "API Reference",
+    "title.memberPage": "{name}"
+  },
+  "outputs": [
+    {
+      "name": "markdown",
+      "path": "./api"
+    }
+  ],
+  "hidePageHeader": false,
+  "logLevel": "Verbose"
+}
diff --git a/packages/client/tsconfig.json b/packages/client/tsconfig.json
@@ -37,6 +37,6 @@
     "theme": "default",
     "exclude": "**/+(__tests__|__mocks__)/*",
     "excludePrivate": true,
-    "excludeProtected": true
-  }
+    "excludeProtected": true,
+  },
 }
diff --git a/packages/lex-cli/package.json b/packages/lex-cli/package.json
@@ -13,7 +13,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf dist",
-    "prepublish": "pnpm run clean && pnpm run build"
+    "prepare": "pnpm run clean && pnpm run build"
   },
   "dependencies": {
     "clipanion": "4.0.0-rc.4",
diff --git a/packages/lexicons/package.json b/packages/lexicons/package.json
@@ -20,7 +20,7 @@
     "build": "tsx ./scripts/generate-types.ts && tsc",
     "check-version-change": "tsx ./scripts/check-version-change.ts && tsc",
     "clean": "rm -rf dist && rm -rf lexicons",
-    "prepublish": "pnpm run clean && pnpm run build"
+    "prepare": "pnpm run clean && pnpm run build"
   },
   "devDependencies": {
     "@tsky/lex-cli": "workspace:*",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`.vitepress/cache/`
`2`	`2`	`.vitepress/dist/`
	`3`	`+api/`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,6 @@`
`37`	`37`	`"theme": "default",`
`38`	`38`	`"exclude": "*/+(__tests__\|__mocks__)/",`
`39`	`39`	`"excludePrivate": true,`
`40`		`- "excludeProtected": true`
`41`		`- }`
	`40`	`+ "excludeProtected": true,`
	`41`	`+ },`
`42`	`42`	`}`