Yari 项目教程

1. 项目介绍

Yari 是一个用于构建和部署 MDN Web 文档的工具。它是 MDN (Mozilla Developer Network) 文档平台的核心组件，负责将 Markdown 文件转换为静态 HTML 页面，并提供强大的搜索和导航功能。Yari 的目标是提供一个高效、可扩展的文档构建系统，支持多种内容格式和丰富的插件生态。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保你已经安装了以下工具：

• Node.js (建议版本 14.x 或更高)
• npm (通常随 Node.js 一起安装)

2.2 安装 Yari

首先，克隆 Yari 项目到本地：

git clone https://github.com/mdn/yari.git
cd yari

然后，安装项目依赖：

npm install

2.3 启动开发服务器

安装完成后，你可以启动开发服务器来预览文档：

npm start

启动后，打开浏览器访问 http://localhost:3000，你将看到 Yari 的默认文档页面。

2.4 构建静态站点

如果你想构建静态站点，可以使用以下命令：

npm run build

构建完成后，静态文件将生成在 dist 目录中。

3. 应用案例和最佳实践

3.1 自定义文档内容

Yari 支持自定义文档内容。你可以在 content 目录中添加或修改 Markdown 文件，Yari 会自动将其转换为 HTML 页面。

例如，创建一个新的 Markdown 文件 content/my-page.md：

# 我的页面

这是一个自定义页面。

保存后，刷新浏览器，你将看到新的页面。

3.2 使用插件扩展功能

Yari 支持通过插件扩展功能。你可以在 plugins 目录中添加自定义插件，或者使用社区提供的插件。

例如，安装一个 Markdown 扩展插件：

npm install markdown-it-emoji

然后在 config.js 中配置插件：

module.exports = {
  plugins: [
    require('markdown-it-emoji')
  ]
};

这样，你的文档中就可以使用 Emoji 了。

4. 典型生态项目

4.1 MDN Web 文档

MDN Web 文档是 Yari 的主要应用场景之一。它提供了丰富的 Web 开发文档，涵盖 HTML、CSS、JavaScript 等多个领域。

4.2 自定义文档站点

Yari 可以用于构建任何类型的文档站点，包括技术文档、产品手册、博客等。通过自定义主题和插件，你可以轻松创建符合需求的文档站点。

4.3 社区插件

Yari 拥有一个活跃的社区，提供了许多有用的插件，如代码高亮、表格生成、数学公式支持等。你可以通过 npm 或 GitHub 找到这些插件，并集成到你的项目中。

---

通过本教程，你应该已经掌握了 Yari 的基本使用方法。希望你能利用 Yari 构建出优秀的文档站点！