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 支持, 謝謝.