访问以前的文档版本
本网站文档仅涵盖 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 源文件构建网站。服务器上线后,使用浏览器导航到 http://localhost:8080
。
警告
SDK 代码示例在 Meilisearch v0.17 - v1.1 的文档本地副本中不可用。
v0.11-v0.16:运行简单的 Python 服务器
要访问 v0.11 到 v0.16 的 Meilisearch 文档,需要在本地计算机上启动 HTTP 服务器。在控制台上运行以下命令
python3 -m http.server 8080
服务器上线后,使用浏览器导航到 http://localhost:8080
。
上面的示例使用 Python 启动本地服务器,但诸如 npx serve
之类的替代方案也同样有效。
v0.8 到 v0.10:阅读 markdown 源文件
早期版本的文档网站上的构建工作流程涉及多种已弃用的工具和库。浏览源 markdown 文件,可以在本地使用现代文本编辑器,也可以远程使用 GitHub 的界面。