TDK

TDK(TealUI Development Kit) 是一个零配置的前端组件化解决方案，主要用于以下四个场景：

• 提取 API 文档：扫描现有源码注释，并自动提取 API 文档；
• 制作技术文档：将 Markdown 文档一键转换成包含导航、搜索的漂亮网站；
• 生成框架官网：一键为你的框架或组件库生成官网，包含漂亮首页、在线示例、教程和 API 手册；
• 搭建 UI 组件库：提供开发一套组件库所需的全套工具，比如实时构建、在线演示、组件自动化测试。

快速上手

1. 安装

推荐全局安装 TDK，这样不需要在每个项目重新安装：

npm i tdk -g

2. 本地预览文档

无需配置，直接进入到你的项目根目录（或建一个空文件夹），然后执行：

tdk start --open .

执行后会自动在浏览器打开生成的文档首页。

服务器会持续监听项目内的文件，并在文件被修改后实时显示最新的文档内容。

3. 发布文档

使用以下命令将文档全部导出到 dist，然后将内部所有文件上传到你的静态资源服务器即可供他人访问：

tdk build

了解更多

查看更多文档