访问以前的文档版本
此文档网站仅涵盖 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 的文档内容和构建代码分别存储在不同的仓库中。因此,无法运行文档网站的本地副本。
要访问 v1.2 及更高版本的 Meilisearch 文档,请直接阅读 .mdx
文件,可以使用现代文本编辑器在本地读取,或使用 GitHub 的界面远程读取。
v0.17-v1.1:运行本地 Vuepress 服务器
安装依赖项
此版本的 Meilisearch 文档使用 Yarn 管理其依赖项。运行以下命令以安装所有必需的软件包
yarn install
启动本地服务器
安装依赖项后,使用 Yarn 启动服务器
yarn dev
Yarn 将从 Markdown 源文件构建网站。服务器上线后,使用浏览器导航到 http://127.0.0.1:8080
。
警告
Meilisearch v0.17 - v1.1 的文档本地副本中不提供 SDK 代码示例。
v0.11-v0.16:运行简单的 Python 服务器
访问 Meilisearch v0.11 到 v0.16 的文档需要在本地机器上启动一个 HTTP 服务器。在控制台中运行以下命令
python3 -m http.server 8080
服务器上线后,使用浏览器导航到 http://127.0.0.1:8080
。
以上示例使用 Python 启动本地服务器,但 npx serve
等替代方案同样有效。
v0.8 到 v0.10:读取 Markdown 源文件
早期版本文档网站的构建流程涉及多个已弃用的工具和库。请浏览源 Markdown 文件,可以使用现代文本编辑器在本地浏览,或使用 GitHub 的界面远程浏览。