本文档网站仅涵盖 Meilisearch 的最新稳定版本。但您可以通过我们的 GitHub 仓库查看历史版本的文档。

本指南将向您展示如何克隆 Meilisearch 文档仓库、获取特定版本的内容并在本地机器上阅读。

虽然本指南旨在帮助旧版本用户满足基本需求,但这并非长期解决方案,也不鼓励用户继续使用过时的 Meilisearch 版本。在绝大多数情况下,升级到最新 Meilisearch 版本是更好的选择

根据具体版本的不同,访问旧版文档的过程可能会遇到困难或错误。特此提醒!

前提条件

要遵循本指南,您需要熟悉命令行操作。开始前请确保您的机器已安装以下工具:

克隆仓库

要访问 Meilisearch 的历史文档版本,第一步是将文档仓库下载到本地机器。在 Git 中这被称为克隆操作。

打开控制台并运行以下命令。这将在当前位置创建一个包含 Meilisearch 文档站点项目文件的 documentation 目录:

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 源文件构建网站。服务器启动后,在浏览器中访问 http://localhost:8080

Meilisearch v0.17 - v1.1 版本的本地文档副本中不提供 SDK 代码示例。

v0.11-v0.16:运行简易 Python 服务器

访问 Meilisearch v0.11 至 v0.16 版本的文档需要在本地启动 HTTP 服务器。在终端运行以下命令:

python3 -m http.server 8080

服务器启动后,在浏览器中访问 http://localhost:8080 即可查看文档。

上述示例使用 Python 启动本地服务器,但其他替代方案如 npx serve 同样适用。

v0.8 至 v0.10:直接阅读 Markdown 源文件

早期版本文档网站的构建流程涉及多个已弃用的工具和库。您可以通过现代文本编辑器本地浏览 Markdown 源文件,或直接使用 GitHub 界面远程查看。