DocFX 搜索功能:模糊搜索和中文搜索指南
DocFX 的搜索功能默认是支持模糊搜索和搜索中文的。\r\n\r\n对于模糊搜索,可以在搜索关键字后面添加 ~
符号来进行模糊搜索。例如,搜索关键字 apple~
将会匹配到 apple
、apples
、application
等相关结果。\r\n\r\n对于搜索中文,DocFX 支持使用中文进行搜索,只需要在搜索框中输入中文关键字即可。\r\n\r\n需要注意的是,为了使搜索功能正常工作,需要确保你的文档已经正确配置了搜索索引。你可以在 DocFX 的配置文件(docfx.json
)中设置 globalMetadata
属性来指定要包含在搜索索引中的文件和文件夹。例如:\r\n\r\njson\r\n"globalMetadata": {\r\n "source": [\r\n {\r\n "files": [\r\n "*.md",\r\n "*.yml"\r\n ],\r\n "exclude": [\r\n "_site/**",\r\n "docs/**"\r\n ]\r\n }\r\n ]\r\n}\r\n
\r\n\r\n在上述示例中,source
属性指定了要包含在搜索索引中的文件和文件夹的匹配模式,并且使用 exclude
属性排除了一些不需要包含在搜索索引中的文件夹。\r\n\r\n如果你的搜索功能不正常工作,你可能需要检查你的配置文件中的搜索索引配置是否正确。
原文地址: http://www.cveoy.top/t/topic/qAju 著作权归作者所有。请勿转载和采集!