SiFli-Wiki

芯片SDK开发文档

快速开始

Linux/macOS 双语构建

当前文档源文件采用两套目录：

• 中文：source/zh_CN
• 英文：source/en

构建时不要再使用 PO/gettext 的 -D language=en 方式，直接运行：

scripts/build_parallel_docs.sh

脚本会生成：

• 中文站点：build/
• 英文站点：build/en/

Windows 用户

1. 首次使用 - 设置环境

   • 双击运行 setup_env.bat
   • 等待环境设置完成
   • 仅需首次使用时运行一次，后续只需运行 start_dev.bat 即可

2. 启动开发服务器（推荐）

   • 双击运行 start_dev.bat 启动开发服务器
   • 浏览器会自动打开 http://localhost:8000
   • 编辑 source 目录下的文档文件，保存后自动刷新

3. 提交代码

   • 双击运行 commit_to_github.bat
   • 按提示输入提交信息,提交信息为修改原因
   • 提交后会自动推送到 GitHub 仓库