1. 介绍
1.1. API文档
|
以上API文档使用JsDoc提取代码中语法（Markdown格式）自动生成，规范化代码注释最终生成具有可读性的API文档，执行在线发布。 |
1.2. 基础环境
| 环境 | 版本 |
|---|---|
Ruby |
3.2+ |
Node |
20.1.x+ |
Java |
17+ |
1.3. 文档本地化
您可以将本规范文档搭建在本地执行修改和调试，本地执行方法，先在本机 全局 安装相关依赖包：
npm install -g jsdoc live-server
npm install docdash taffydb
brew install asciidoctor # MacOS|
asciidoctor最好参考官方文档安装在操作系统级别，以防止执行命令时引起不必要的路径问题，上述命令是 MacOS 中的安装方法，其他安装方法参考 Asciidoctor Install and Update，且安装之前确认已具备基础环境需求。
|
安装完成后，执行下边两个核心命令：
./run-doc.sh doc # 1.生成文档
./run-doc.sh server # 2.启动文档服务器|
可以在服务器启动状态下直接重新生成文档，生成完成后刷新浏览器即可。 |
其他前端教程直接参考云端白皮书中的前端部分，统一处理 云端白皮书 ，本章节中不做特殊说明。