跳至主要內容

DocSearch 遷移

·閱讀 3 分鐘
Clément Vannicatte
Clément Vannicatte
Algolia 軟體工程師
Sébastien Lorber
Sébastien Lorber
Docusaurus 維護者，This Week In React 編輯

DocSearch 遷移至一個新的更強大的系統，這個系統為使用者提供他們自己的 Algolia 應用程式和新的認證資料。

Docusaurus 網站所有者應該使用他們新的認證資料升級他們的設定，在 2022 年 2 月 1 日之前，現有的搜尋索引會在這個日期之後凍結並變成唯讀。

升級你的 Docusaurus 網站​

在接下來的幾週內，Docusaurus 網站所有者會收到一封電子郵件，邀請他們加入他們個人的 Algolia 應用程式。

這封電子郵件會包含一個新的 appId 和 apiKey，供你在 Docusaurus 設定中使用。

你只需要做的

  • 加入 Algolia 應用程式（視情況建立新的 Algolia 帳戶）
  • 更新網站設定。
docusaurus.config.js
const config = {
  themeConfig: {
    algolia: {
      appId: '<NEW_APP_ID>',
      apiKey: '<NEW_SEARCH_API_KEY>',
    },
  },
};

module.exports = config;
資訊

現在**需要**appId 。

這些金鑰不算是秘密，可以加入您的 Git 儲存庫中。

DocSearch 有新的家囉！​

DocSearch 是什麼？​

DocSearch 是一個由 Algolia 所建立的程式，提供技術文件、開源專案和技術部落格的搜尋功能完全免費。

您可以在 這裡進一步了解，如果您有興趣，可以 申請！

這次的遷移是要做什麼？​

動機​

隨著 DocSearch UI 即將推出穩定的版本，我們希望更進一步提供更好的工具給使用者來提升搜尋體驗，同時善用 Algolia 的全部潛力。

有哪些新功能？​

DocSearch 現在會使用 Algolia Crawler，它的網路介面讓您可以

  • 開始、排程和監控您的爬取程式
  • 使用即時編輯器修改設定檔
  • 使用 DocSearch v3 測試您的結果

The Algolia crawler front page showing the project&#39;s overview, such as last complete crawl and indices

The Algolia config editor opened to the docusaurus-2 config. The right pane shows the results for index and various facet filters.

還有更多 Algolia 功能在您自己的 Algolia 應用程式中

  • 團隊管理
  • 瀏覽和查看您的記錄如何在 Algolia 中建立索引
  • 使用免費試用版體驗其他 Algolia 功能

The Algolia index overview page, showing various filters and the details of every single index

The Algolia index analytics page, showing trends for total users, total searches, etc.

當然還有更多好康，完全免費。

常見問答​

我正在使用 Docusaurus 和 DocSearch，可以遷移嗎？​

我們在撰寫本文時，仍處於迁移的早期階段。我們每週都會進行小批次，但很快就會增加負載，因此請耐心等待並留意您的信箱，一旦您的 Algolia 應用程式準備好，我們將會與您聯繫！

在哪裡可以閱讀更多相關資訊？​

我們撰寫了一份簡短的 迁移指南，但您可以在迁移電子郵件中找到更詳細的資訊。

我收到了迁移電子郵件，但邀請已過期​

請透過 電子郵件 或 DocSearch 的 Discord 或 Docusaurus 的 Discord #algolia 頻道 聯絡我們。

我有回饋！​

對於關於我們的文件或 DocSearch UI 元件的任何回饋，您可以在我們的 GitHub 儲存庫 中提出問題，也可以透過以上方式與我們聯繫。

我仍然可以執行自己的 DocSearch 執行個體嗎？​

為了支持新的基礎設施和 DocSearch v3，我們將不再維護我們心愛的 DocSearch scraper 和 DocSearch v2，但這些儲存庫仍會公開，並接受提交請求。

之前的文件（現在稱為 legacy）仍然可用，我們的 run your own 指南也是如此。