存取舊版文件
本文件網站僅涵蓋 Meilisearch 最新穩定版本。但是,可以查看儲存在我們的 GitHub 儲存庫中先前 Meilisearch 版本的文檔。
本指南將說明如何複製 Meilisearch 的文件儲存庫、提取特定版本的內容,並在您的本機電腦上閱讀。
警告
雖然本指南的目標是協助舊版本的用戶滿足其最低需求,但並非旨在作為長期解決方案或鼓勵用戶繼續使用過時版本的 Meilisearch。在幾乎所有情況下,**最好升級到最新的 Meilisearch 版本**。
根據所討論的版本,存取舊文件的過程可能很困難或容易出錯。請注意!
先決條件
若要遵循本指南,您應該熟悉命令列。開始之前,請確保您的電腦上已安裝以下工具
複製儲存庫
若要存取先前版本的 Meilisearch 文件,第一步是將文件儲存庫下載到您的本機電腦。在 Git 中,這稱為複製。
開啟您的主控台並執行以下命令。它將在您目前的位置建立一個 documentation
目錄,其中包含 Meilisearch 文件網站的專案檔案
git clone https://github.com/meilisearch/documentation.git
或者,您可以使用 SSH URL 複製儲存庫。
選擇 Meilisearch 版本
此文件儲存庫包含從 v0.8
到最新版本的標籤。使用這些標籤以及 git checkout
來存取特定版本。
例如,以下命令會檢索 Meilisearch v0.20 的文件
git checkout v0.20
造訪 GitHub 上的儲存庫以查看所有文件標籤。
存取文件
根據您所檢出的版本,有不同的方式可以存取先前 Meilisearch 版本的相關文件。
警告
網站搜尋列在文件的本地副本中無法使用。
>= v1.2:讀取 .mdx
檔案
從 v1.2 開始,Meilisearch 的文件內容和建置程式碼存放在不同的儲存庫中。因此,無法執行文件的本地網站副本。
若要存取 1.2 和更高版本的 Meilisearch 文件,請直接讀取 .mdx
檔案,可以使用現代文字編輯器在本機讀取,或使用 GitHub 介面遠端讀取。
v0.17-v1.1:執行本地 Vuepress 伺服器
安裝相依性
此版本的 Meilisearch 文件使用 Yarn 來管理其相依性。執行以下命令來安裝所有需要的套件
yarn install
啟動本機伺服器
安裝相依性之後,使用 Yarn 來啟動伺服器
yarn dev
Yarn 會從 Markdown 來源檔案建置網站。伺服器上線後,請使用您的瀏覽器瀏覽至 https://127.0.0.1:8080
。
警告
SDK 程式碼範例在 Meilisearch v0.17 - v1.1 的文件本地副本中無法使用。
v0.11-v0.16:執行簡單的 Python 伺服器
若要存取 v0.11 到 v0.16 的 Meilisearch 文件,需要在您的本機電腦上啟動 HTTP 伺服器。在您的主控台中執行以下命令
python3 -m http.server 8080
伺服器上線後,請使用您的瀏覽器瀏覽至 https://127.0.0.1:8080
。
以上範例使用 Python 來啟動本機伺服器,但其他替代方案(例如 npx serve
)的效果也一樣好。
v0.8 到 v0.10:讀取 Markdown 來源檔案
早期版本的文件網站建置工作流程涉及多個已棄用的工具和函式庫。請瀏覽 Markdown 來源檔案,可以使用現代文字編輯器在本機讀取,或使用 GitHub 介面遠端讀取。