作为一名开发者,你一定知道 MDN Web Docs(Mozilla 开发者网络文档)。然而,MDN 官方网站访问速度不稳定,这可能会让你感到困扰。那么,如何在自己的服务器上搭建 MDN 文档,以更快的速度获取所需文档呢?接下来,让我们一起来探究一下吧!
第一步:获取 MDN 源代码
首先,我们需要从 MDN 的官方 GitHub 仓库中获取源代码。该仓库包含了 MDN 的所有内容,包括文档、示例代码、API 等。你可以通过以下步骤获取:
- 访问 MDN GitHub 仓库
- 点击右侧的绿色按钮 “Code”,选择 “Download ZIP” 下载源代码包。
- 解压下载的压缩包,得到包含所有内容的
mdn-content
文件夹。
第二步:生成 HTML 并设置中文显示
获取源代码之后,我们需要将其转换为 HTML 格式并且设置中文显示。下面是具体步骤:
- 打开命令行工具(Terminal),进入
content-main
文件夹。 - 运行以下命令安装必要的依赖项:
npm install
- 依然在命令行工具中,运行以下命令将 MDN 文档转换为 HTML 并设置中文显示:
npm run build -- --locale=zh-cn
这个命令将会在本地的 build
目录中生成一个静态网站,其中包含了 MDN Web Docs 的中文文档。
运行后发现一个问题报错 :CONTENT_TRANSLATED_ROOT: not set
解决方案 CONTENT_TRANSLATED_ROOT: not set
这个错误通常是由于缺少环境变量或配置问题引起的。根据 MDN Web Docs 的官方文档,要在本地构建已翻译的中文文档,您需要执行以下操作:
- 运行以下命令获取 MDN Web Docs 的代码:
git clone https://github.com/mdn/content-translations.git
- 在
content-main
创建content-translations
目录,并使用以下命令安装依赖项:
npm install
- 运行以下命令设置环境变量:
export CONTENT_TRANSLATED_ROOT=$PWD/content-translations
`$PWD` 是一个特殊的环境变量,表示当前工作目录的绝对路径。在 Linux 和 Unix 系统中,`$PWD` 变量通常由 shell 在运行时自动设置,以反映当前的工作目录。在这种情况下,命令 `export CONTENT_TRANSLATED_ROOT=$PWD/content-translations` 将会设置一个环境变量 `CONTENT_TRANSLATED_ROOT`,其值为 `content-translations` 目录的绝对路径。
在 Windows 系统中,您可以使用 `%CD%` 替代 `$PWD` 来获取当前工作目录的绝对路径。因此,命令 `export CONTENT_TRANSLATED_ROOT=%CD%/content-translations` 将会设置一个环境变量 `CONTENT_TRANSLATED_ROOT`,其值为 `content-translations` 目录的绝对路径。
总之,`$PWD` 表示当前工作目录的路径,用于在命令行中获取当前所在的目录。
- 稍等片刻,转换完成后,你会在
content-main/build
文件夹中找到生成的 HTML 文件。打开其中任意一个文件,你就能在本地浏览器中愉快地阅读了!
通过以上步骤,你已经成功地在自己的服务器上搭建了 MDN 文档!现在,你可以随时查看所需的文档,而不用担心访问速度不稳定的问题。
😎🎉 轻松享受高质量文档资料,何乐而不为?如果你有任何疑问或建议,欢迎在评论区留言,我们期待听到你的声音!