访问旧版文档
Meilisearch 文档仅涵盖引擎的最新稳定版本。了解如何访问 Meilisearch 旧版文档。
本文档网站仅涵盖 Meilisearch 的最新稳定版本。但是,您可以查看存储在我们的 GitHub 仓库中的 Meilisearch 旧版文档。
本指南将向您展示如何克隆 Meilisearch 的文档仓库,获取特定版本的内容,并在您的本地机器上阅读它。
本指南旨在帮助旧版本用户满足其最低限度需求,但它并非长期解决方案,也不鼓励用户继续使用过时的 Meilisearch 版本。在几乎所有情况下,升级到最新的 Meilisearch 版本会更好。
根据所讨论的版本,访问旧版文档的过程可能很困难或容易出错。请注意!
先决条件
要遵循本指南,您应该对命令行有所了解。在开始之前,请确保您的机器上安装了以下工具
克隆仓库
要访问 Meilisearch 文档的旧版本,第一步是将文档仓库下载到您的本地机器。在 Git 中,这称为克隆。
打开您的控制台并运行以下命令。它将在您当前位置创建一个包含 Meilisearch 文档站点项目文件的 documentation
目录
或者,您可以使用 SSH URL 克隆仓库。
选择 Meilisearch 版本
文档仓库包含从 v0.8
到最新版本的标签。将这些标签与 git checkout
结合使用来访问特定版本。
例如,以下命令将检索 Meilisearch v0.20 文档
访问 GitHub 上的仓库以查看所有文档标签。
访问文档
根据您检出的版本,有不同的方式访问 Meilisearch 以前版本的文档。
文档网站的本地副本中,站点搜索栏无法使用。
>= v1.2: 阅读 .mdx
文件
从 v1.2 开始,Meilisearch 的文档内容和构建代码位于不同的仓库中。因此,无法运行文档网站的本地副本。
要访问 v1.2 及更高版本的 Meilisearch 文档,可以直接阅读 .mdx
文件,无论是使用现代文本编辑器在本地阅读,还是使用 GitHub 界面远程阅读。
v0.17-v1.1: 运行本地 Vuepress 服务器
安装依赖
此版本的 Meilisearch 文档使用 Yarn 管理其依赖项。运行以下命令以安装所有必需的包
启动本地服务器
安装依赖后,使用 Yarn 启动服务器
Yarn 将从 Markdown 源文件构建网站。服务器上线后,请使用浏览器导航到 http://localhost:8080
。
Meilisearch v0.17 - v1.1 文档的本地副本中不提供 SDK 代码示例。
v0.11-v0.16: 运行一个简单的 Python 服务器
访问 v0.11 到 v0.16 版本的 Meilisearch 文档需要在您的本地机器上启动一个 HTTP 服务器。在您的控制台中运行以下命令
服务器上线后,请使用浏览器导航到 http://localhost:8080
。
上述示例使用 Python 启动本地服务器,但诸如 npx serve
之类的替代方案同样适用。
v0.8 到 v0.10: 阅读 Markdown 源文件
早期版本的文档网站的构建工作流涉及多个已弃用的工具和库。可以通过现代文本编辑器在本地或使用 GitHub 界面远程浏览 Markdown 源文件。