参考层 · 工程化细节,汇总开发流程、调试方式和文档站部署方式
开发与运维
一句话结论
这一层主要体现项目的工程完成度,包括构建、烧录、调试、版本管理和文档站发布流程。
VS Code 开发
当前项目已经支持在 VS Code 中完成:
- 构建
- 烧录
- 调试
常用流程:
BuildFlashDebug STM32F103 (OpenOCD)
命令行等价操作:
powershell
cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE=cmake/toolchain-arm-none-eabi.cmake
cmake --build build -j
openocd -f interface/stlink.cfg -f target/stm32f1x.cfg -c "program build/stm32f103.elf verify reset exit"版本管理建议
推荐保留两个长期分支:
main:稳定展示 / 发布dev:日常开发
提交前缀建议:
feat:fix:refactor:docs:chore:
文档站本地开发
bash
npm install
npm run docs:devCloudflare Pages 发布
当前文档站通过 GitHub Actions 直传到 Cloudflare Pages。
需要在 GitHub 仓库 Secrets 中配置:
CLOUDFLARE_API_TOKENCLOUDFLARE_ACCOUNT_ID
Cloudflare Pages 项目名固定为:
text
levi882-stm32-docs