Facebook Docusaurus 中文文档 启用搜索

此系列文章的应用示例已发布于 GitHub: docusaurus-docs-Zh_CN. 能够 Fork 帮助改进或 Star 关注更新. 欢迎 Star.

启用搜索

Docusaurus 支持使用 Algolia DocSearch 进行搜索。 一旦你创建了你的网站，输入你的网站信息 来让 Algolia 抓取你网站的文档页面。 Algolia 会向您发送您的网站的 API 密钥和索引名称。

启用搜索栏

在 algolia 部分的 siteConfig.js 中输入您的搜索 API 密钥和索引名称，以启用您的网站搜索。

const siteConfig = {
  ...
  algolia: {
    apiKey: "my-search-only-api-key-1234",
    indexName: "my-index-name"
  },
  ...
}

额外搜索参数

您还能够在 algolia 中使用algoliaOptions字段指定额外的 Algolia 使用的搜索参数。 若是您想为文档的不一样版本或语言提供不一样的搜索结果，这可能会颇有用。 任何 "VERSION" 或 "LANGUAGE" 都将被当前页面的版本或语言所取代。 关于搜索选项的更多细节能够在这里找到。

const siteConfig = {
  ...
  algolia: {
    ...
    algoliaOptions: { 
      facetFilters: [ "tags:VERSION" ], 
      hitsPerPage: 5 
    }
  },
}

控制搜索栏位置

默认状况下，搜索栏将是顶部导航栏中最右边的元素。

若是您想更改默认位置，请在 siteConfig.js 的 headerLinks 字段中将 searchBar 标志添加到您想要的位置。 例如，您可能须要在内部和外部连接之间的搜索栏。

const siteConfig = {
  ...
  headerLinks: [
    {...}
    {...}
    { search: true }
    {...}
    {...}
  ],
  ...
}

禁用搜索栏

要禁用搜索栏，请注释掉（推荐）或删除 siteConfig.js 文件中的 algolia 部分。

另外，若是您在 headerLinks 中自定义了搜索栏的位置，请设置 search: false。

若是这篇文章对您有帮助, 感谢 下方点赞 或 Star GitHub: docusaurus-docs-Zh_CN 支持, 谢谢.