vkedit 文档站

vkedit 图形编辑器插件库的官方文档站点，部署于 docs.vkedit.org。

落地页（vkedit.org）为独立项目，本仓库仅负责文档。

技术栈

• VitePress -- 文档站点框架
• TypeDoc + typedoc-plugin-markdown -- API 文档自动生成
• Vue 3 -- 自定义主题组件

目录结构

.
├── .vitepress/
│   ├── config.ts              # 站点配置（导航、侧边栏、主题）
│   ├── theme/                 # 自定义主题与组件
│   │   ├── components/        # Vue 组件（首页等）
│   │   └── styles/            # 全局样式与品牌变量
│   └── scripts/
│       ├── gen-api.mjs        # 从 vkedit 类型定义生成 API 文档
│       ├── enhance-api.mjs    # 将人工补充内容追加到 API 文档
│       └── enhancements/      # 人工补充的 API 说明（按类名命名）
├── guide/                     # 使用指南（手写）
├── api/                       # API 参考（自动生成，勿手改）
├── public/                    # 静态资源
├── deploy/                    # 部署配置（nginx、部署脚本）
└── index.md                   # 文档介绍页（站点入口）

开发

# 安装依赖
pnpm install

# 启动开发服务器
pnpm dev

# 构建（不含 API 重新生成）
pnpm build

# 完整构建（重新生成 API 文档 + 构建）
pnpm build:full

API 文档生成

API 文档由 pnpm gen:api 从 vkedit 包的 TypeScript 类型定义自动生成，输出到 api/ 目录。

如需为某个类补充人工说明，在 .vitepress/scripts/enhancements/{ClassName}.md 创建同名文件，enhance-api.mjs 会在生成时将其内容追加到对应 API 页面末尾。

api/ 目录为生成产物，请勿手动编辑。

部署

站点部署在 docs.vkedit.org，相关配置见 deploy/ 目录。

相关仓库

• 主库：vkedit
• 落地页：vkedit.org（独立项目）