一个快速、现代、LLM的文档网站,供您使用 类型脚本 项目,由TypeDoc提供动力.
TypeDoc 插件, 将项目反射变成快速的现代静态
站点: 服务器提交 HTML, 懒惰水分互动岛屿, 模糊 + 全文
搜索、 轻而易举和黑暗的主题, 以及同伴 .md 的每页.
要点
- 为类型脚本所建 ——您的 TypeDoc 反射成为结构化的 API 模型,然后是被打磨过的静态站点. 没有 CSS 或构建配置开始 .
- 无框架快速( F) ——服务器上带有懒惰水分的页面 岛屿;每页只装上它实际使用的JS.
- 搜索构建于 模糊的命令调色板(
Ctrl K关于头衔, 描述、内容和每个成员的深层链接。 总是这样,没什么 配置 . - 一个站点中的指南 + API 手写Markdown指南和 自动生成的引用共享一个侧边栏和一个搜索.
- 正在本地化 - 那个
clean-jsdoci18n 工具已经提取 typeDoc 工程的可变字符串; 完整的每地建置( 有 语言切换器,每个语言字体,以及hreflang下一个降落. - 方便LLM 每页都有一个干净的同伴
.md外加一个 复制页面按钮可以将任意一页交给克洛德 / ChatGPT / 困惑. A 类 可下载 技能 转弯 任何编码助理都变成设置专家. - 默认波兰文 ——轻/暗的OKLCH主题,Google字体,shiki语法
摩纳哥源浏览器,以及
Source: file:line链接.
快开始
npm install --save-dev typedoc @clean-jsdoc-theme/typedoc
typedoc 是同伴的依赖性——你带来自己的。 装入插件并选择
其输出在 typedoc.json; 主题选项位于 cleanJsdocTheme数字 :
{
"entryPoints": ["src/index.ts"],
"plugin": ["@clean-jsdoc-theme/typedoc"],
"outputs": [{ "name": "clean-jsdoc-theme", "path": "dist" }],
"cleanJsdocTheme": {
"siteName": "My Library",
// Optional: a directory of hand-written Markdown/HTML guides rendered
// alongside the API (folder layout → URL + sidebar group; per-file
// frontmatter overrides; a root `index.md` becomes the home page).
"docs": "docs"
}
}
主页来自TypeDoc自己的顶级
"readme"选项(或根)docs/index.md) (中文(简体) ). 两者readme和主题块坐落在顶层typedoc.json—— 说readme是 TypeDoc 的, 主题选项在cleanJsdocTheme。 。 。 .
构建,然后在 HTTP 之上服务(获取岛屿块和搜索索引) file:// 块 :
npx typedoc
npx serve dist
文档
- 设置完整引用( F) —— 说 akdev.me/ clean-jsdoc-主题/主题/类型doc-得到-启动: 安装,即
cleanJsdocTheme选项和主题——所有配置在cleanJsdocTheme在你身边typedoc.json。 。 。 . - 改用联署文件? 安装
clean-jsdoc-theme——JSDoc模板,外观和功能设定相同. - FAQ 食谱( C) —— 说 akdev.me/ clean-jsdoc-主题/指南/faq:如何嵌入 CodePen / YouTube / 站点,写出丰富的Doc评论(callouts, steps),以及常见的配置tweaks.
- 现场演示 —— 说 akdev.me/ clean-jsdoc-主题/api-docs: 一个真实生成的 API 引用, 这样您可以在安装前看到输出 .
捐款额
反馈直接塑造此插件, 欢迎贡献者 :
- 🐛 击出错误还是奇数输出? 打开一个问题 小小的复制——这是你所能做的最有用的一件事.
- 💡 错过了什么还是有什么想法? 专题请求和问题可在 问题跟踪器。 。 。 .
- 🛠️ 想挖进去吗? 公关是真正受欢迎的. 适配器住在这里
packages/typedoc/(数量)NOTES.md记录它所依赖的经过核实的TypeDoc API事实。 方便开始的区域:类型渲染,反射边缘外壳,以及局部构造. 见 捐款额。 。 。 .
任何贡献都不算太小——一个打字法、一个复写法,或者一个docs tweak all help. 对照类型文件验证 0.28.x (中文(简体) )。谢谢帮助制作 TypeScript 记录故事的精彩
贡献者
感谢所有帮助建立干净的jsdoc主题的人.