跳转至

中文搜索​支持

添加了实验性的中文支持(鉴于大量中国用户,该功能长期以来一直被要求)


MkDocs for Material 用户的第三大原产国是中国。长期以来,内置搜索插件无法正确分割汉字,主要是由于缺少对用于搜索标记化和词干提取的lunr 语言的支持。最新的 Insiders 版本为内置搜索插件增加了期待已久的中文支持,这是许多用户所要求的。

Material for MkDocs 终于​支持​中文​了!文本​被正确分割​并且​更​容易​找到。

配置

MkDocs Material 的中文支持由jieba提供,这是一个优秀的中文分词库。如果安装了jieba,内置的搜索插件会自动检测汉字并通过分词器运行它们。您可以使用以下方式安装jieba

pip install jieba
仅当您在 中指定分隔符配置时,才需要执行下一步 mkdocs.yml。文本用零宽度空白字符分割,因此它在搜索模式中呈现完全相同。调整 mkdocs.yml 以使分隔符包含 \u200b 字符:

plugins:
  - search:
      separator: '[\s\u200b\-]'

这就是所有必要的。

用法

如果您按照配置指南中的说明进行操作,现在将使用jieba对中文单词进行标记。尝试搜索 支持查看它如何与内置搜索插件集成。