用途:为 Rspress 文档站点的 Markdown/MDX 页面补齐缺失的 description frontmatter。该字段会生成 <meta name="description">,用于搜索引擎摘要、社交预览与 llms.txt 等 AI 格式。
主要能力:先定位 Rspress 配置(rspress.config.ts/.js/.mjs/.cjs),读取并解析 root 选项(字符串或 JS 表达式),未设置时默认 docs,并确认目录存在,否则回退 doc。检测 i18n 结构:若 docs 根下有语言子目录(如 en/、zh/),逐语言处理,描述语言与内容语言一致;否则视为单语言站点。扫描 **/.md 与 **/.mdx,排除 node_modules、构建输出(doc_build、.rspress、dist)、_meta.json/_nav.json 与 /shared/。已存在非空 description 的跳过;pageType 为 home 的从 hero.text/hero.tagline 或 features 派生,而非正文。随后按规范生成并插入 description:有 title 时插在 title 下一行,无 title 时作为第一个字段,无 frontmatter 则新建 --- 块。多数用裸 YAML 字符串,含冒号、引号等特殊字符时用双引号包裹。文件多时可并行处理,建议按目录分组保持一致,处理后重新扫描确认无遗漏。
写作规范:长度 50–160 字符;语言随内容;直接陈述覆盖内容,避免以 This document/This page/Learn about 开头;具体提及技术、API 或概念;纯文本不用 Markdown。
限制:面向 Rspress 站点;root 解析、i18n 与排除规则如上;未提供安装命令、收费与平台信息。