docs: 添加构建文档脚本

.gitignore

@@ -17,6 +17,7 @@ lerna-debug.log*
 # 临时文件
 logs/
 /temp/
+packages/core/docs/guide/api/types/
 
 # 配置
 packages/core/plugins

.vscode/settings.json

@@ -11,7 +11,7 @@
   "explorer.fileNesting.enabled": true,
   "explorer.fileNesting.patterns": {
     ".env": "*.env",
-    "tsconfig.json": "tsconfig.*.json, env.d.ts, tsup.*.ts, vite.*.ts",
+    "tsconfig.json": "tsconfig.*.json, env.d.ts, tsup.*.ts, vite.*.ts, typedoc.json",
     "package.json": "package-lock.json, pnpm*, .yarnrc*, yarn*, .eslint*, eslint*, .prettier*, prettier*, .editorconfig, CHANGELOG*.md, CODE_OF_CONDUCT.md, *.gitignore, LICENSE, README.md, .release*.json, .gitattributes"
   },
   "files.autoSave": "onFocusChange",

package.json

@@ -35,6 +35,9 @@
     "terser": "^5.39.0",
     "tsup": "^8.4.0",
     "tsx": "^4.19.3",
+    "typedoc": "0.28.14",
+    "typedoc-plugin-markdown": "4.9.0",
+    "typedoc-vitepress-theme": "^1.1.2",
     "typescript": "^5.8.2",
     "vite": "^6.3.6",
     "vite-plugin-dts": "^4.5.4",

packages/core/package.json

@@ -156,7 +156,8 @@
     "pub": "npm publish --access public",
     "pub-beta": "npm publish --access public --tag beta",
     "sort": "sort-package-json && sort-json tsconfig.json",
-    "sync": "curl -X PUT \"https://registry-direct.npmmirror.com/-/package/node-karin/syncs\""
+    "sync": "curl -X PUT \"https://registry-direct.npmmirror.com/-/package/node-karin/syncs\"",
+    "docs:build": "typedoc"
   },
   "dependencies": {
     "art-template": "npm:@karinjs/art-template@1.1.0",

packages/core/src/adapter/render/admin/types.ts

@@ -73,7 +73,7 @@ export declare interface ScreenshotOptions {
   /**
    * 图像的编码方式。
    *
-   * @deprecated 这是无效选项，强制性返回string<base64>
+   * @deprecated 这是无效选项，强制性返回base64编码的字符串
    */
   encoding?: 'base64' | 'binary'
   /**

packages/core/typedoc.config.js

@@ -0,0 +1,75 @@
+/** @type {Partial<import("typedoc").TypeDocOptions>} */
+const config = {
+  $schema: 'https://typedoc.org/schema.json',
+  entryPoints: [
+    'src/index.ts',
+  ],
+  docsRoot: './',
+  out: './docs/guide/api/types',
+  theme: 'default',
+  name: 'Karin API Docs',
+  readme: '../../README.md',
+  lang: 'zh',
+  exclude: [
+    '**/*.test.ts',
+    '**/*.spec.ts',
+    '**/node_modules/**',
+  ],
+  excludePrivate: false,
+  excludeProtected: false,
+  excludeInternal: true,
+  hideGenerator: true,
+  kindSortOrder: [
+    'Document',
+    'Project',
+    'Module',
+    'Namespace',
+    'Enum',
+    'EnumMember',
+    'Class',
+    'Interface',
+    'TypeAlias',
+    'Constructor',
+    'Property',
+    'Variable',
+    'Function',
+    'Accessor',
+    'Method',
+    'Parameter',
+    'TypeParameter',
+    'TypeLiteral',
+    'CallSignature',
+    'ConstructorSignature',
+    'IndexSignature',
+    'GetSignature',
+    'SetSignature',
+  ],
+  categorizeByGroup: true,
+  defaultCategory: '其他',
+  categoryOrder: [
+    '主要功能',
+    '工具函数',
+    '类型定义',
+    '接口',
+    '枚举',
+    '其他',
+  ],
+  gitRevision: 'main',
+  gitRemote: 'origin',
+  includeVersion: true,
+  searchInComments: true,
+  searchInDocuments: true,
+  treatWarningsAsErrors: false,
+  logLevel: 'Error',
+  skipErrorChecking: true,
+  blockTags: [
+    '@description',
+    '@version',
+  ],
+  plugin: [
+    'typedoc-plugin-markdown',
+    'typedoc-vitepress-theme',
+  ],
+}
+
+export default config