Linear如何创建项目文档

时间：2026-09-05 299

Linear项目使用codegen-doc插件从TypeScript源码和GraphQL Schema自动生成API文档，需先执行pnpm build，再运行pnpm run codegen:doc，生成HTML站点至docs目录，通过npx serve -s -l 3000本地预览。

你需要为Linear项目生成结构清晰、可维护的API文档，避免手动编写导致版本脱节或信息遗漏。

使用 codegen-doc 自动生成文档

Linear 项目内置了 codegen-doc 插件，它能从 TypeScript 源码和 GraphQL Schema 中提取类型定义与注释，一键生成静态 HTML 文档站点。

确保你已克隆 Linear 仓库并完成依赖安装（pnpm install 或 yarn install）。

进入项目根目录，运行文档生成命令：

【必须先执行 pnpm build】 否则 codegen-doc 将因缺少编译产物而报错退出。

pnpm run codegen:doc

该命令会读取 packages/sdk/src/ 下的类型定义和三斜杠（///）注释，同时拉取当前项目的 GraphQL Schema，最终在 docs/ 目录下输出完整的 HTML 文档站点。

默认配置位于 packages/codegen-doc/config.ts。若需调整输出内容，可修改以下关键项：

设置 includePaths 控制扫描范围，例如只生成 SDK 的文档：['packages/sdk/src/**/*.ts']。

启用 includeComments: true 才能解析 /// 注释中的

、等 XML 风格标记——不开启则所有注释将被忽略。

修改 outputDir 可指定输出路径，但注意不要设为 node_modules 或 Git 忽略目录，否则本地预览会失败。

第一步：进入 docs 目录

cd docs

第二步：启动静态服务

npx serve -s -l 3000

第三步：打开浏览器访问 http://localhost:3000

这一步不可跳过——直接双击 index.html 会因浏览器同源策略导致资源加载失败，页面空白。

上一篇：百度卫士电脑加速使用指南下一篇：爱山东手机app下载安装官方正版渠道

女子学校安检员安卓最新版

 6.0

模拟经营 20 MB

扫一扫手机安装更便捷