文章编写与维护
新增一篇文章
在相应栏目目录新建 .md 文件,例如在 docs/ai/ 下新建 my-tool.md。文件名使用小写英文与连字符,正文使用中文。
md
---
title: 文章标题(示例)
description: 用一句话说明本文解决的问题。
---
# 文章标题(示例)
::: warning 示例内容
本文为示例,适用版本、信息来源与验证结果待补充。
:::
## 适用范围
待补充。
## 正文
待补充。
## 来源与更新记录
待补充来源链接、核验日期与修改内容。把文章接入导航
- 在
docs/.vitepress/config.mts的themeConfig.sidebar中加入标题和链接。 - 在对应栏目的
index.md添加入口。 - 如果需要推荐到首页,更新
docs/index.md的推荐阅读。
文件 docs/ai/my-tool.md 对应配置链接 /ai/my-tool。正文优先使用 Markdown 链接,例如 [文章标题](../ai/my-tool.md),构建时会转换为站内地址。
图片与附件
可以在文章同级创建 images/ 目录,再使用相对路径,例如 。公共静态资源放在 docs/public/。
发布前检查图片是否已脱敏,外部资料是否有适当的来源说明与使用许可。不要把真实 API 密钥写进文章或截图。
更新已有内容
修改原 Markdown 文件,并记录适用软件版本、来源核验日期和影响使用的变化。未解决的信息继续标记为「待确认」。
从「示例」转为正式文章时,同时更新页首说明、文件中的标题、侧边栏、栏目页及首页中的状态标记。
本地检查
先运行 npm run docs:dev,检查正文、目录、链接和手机宽度下的阅读效果。完成后运行 npm run docs:build,确认生产构建成功;再用 npm run docs:preview 检查构建结果。
搜索索引会在构建时生成。不要直接编辑 docs/.vitepress/dist/ 中的生成文件。