如何编写教程

写作原则

• 一个步骤只完成一件事。
• 操作名称与界面文案保持一致。
• 命令提供可复制的完整示例。
• 明确说明成功时应该看到什么。
• 为常见失败提供具体排查方法。
• 标明工具版本和最后验证日期。

添加新页面

1. 在 docs/ 对应分类中新建 .md 文件。
2. 使用清晰的英文小写文件名，例如 clients/new-tool.md。
3. 在 docs/.vitepress/config.mts 的 sidebar 中加入页面。
4. 运行 npm run docs:dev 检查目录、链接和页面显示。
5. 运行 npm run docs:build 检查是否可以正常构建。