跳转至

内容维护指南

这个网站以 Markdown 为唯一内容源。日常维护主要编辑 docs 目录中的文件。

修改部件

在 docs/components.md 对应表格中修改或新增一行。表头必须保持以下顺序:

部件 | 具体型号 | 类别 | 功能 | 接口 | 连接对象 | 核验状态 | 备注

保存后重新运行:

.\.venv\Scripts\python.exe -m mkdocs build --strict

本地预览:

.\.venv\Scripts\python.exe -m mkdocs serve

浏览器打开 http://127.0.0.1:8000/。页面脚本会自动读取表格并生成卡片、搜索和详情面板。

修改系统图

替换 docs/assets/images 中同名的 SVG 文件,然后重新构建。Markdown 页面不需要改变。

替换部件照片

部件照片位于 docs/assets/images/components。用现机照片替换同名文件后,网页会自动更新;图片与部件的对应关系、来源链接和“实物/外观参考”说明维护在 docs/assets/javascripts/components.js 的 componentImages 清单中。

重新抓取当前公开产品图:

.\scripts\download-component-images.ps1

对于尚未确认具体料号的部件,不要使用相似产品照片并标成现机实物。可以保留外观参考,并在图片说明中写明差异。

核验原则

  1. 具体型号优先采用实物铭牌或刻字。
  2. 其次采用订单、项目配置和厂商资料。
  3. 无法验证的料号写“待实物核验”,并在备注说明缺少什么证据。