如何在DocFX的filterConfig.yml文件中设置正确的YamlMime
解决DocFX filterConfig.yml添加YamlMime后警告未消除的问题
- 检查首行格式与编码:确保
### YamlMime:ManagedReference是文件的第一行,无前置空格、空行或隐藏BOM。用编辑器将文件编码设为UTF-8 无BOM后重新保存。 - 验证文件路径:确认
filterConfig.yml放在DocFX项目的正确位置(通常与docfx.json同目录),或检查docfx.json中是否正确指定了该文件的路径,避免DocFX读取旧的未修改文件。 - 清理缓存后重建:执行以下命令清除DocFX缓存,再重新构建文档:
docfx clean docfx build - 核对标记拼写:确保
### YamlMime:ManagedReference无拼写错误,大小写、符号完全符合要求(三个井号,YamlMime和ManagedReference首字母大写)。 - 更新DocFX版本:若使用旧版本DocFX,可能存在标记识别bug,升级到最新稳定版本后重试。
内容的提问来源于stack exchange,提问作者Andreas
相关产品推荐
相关产品推荐

