首页
/ Yari 项目教程

Yari 项目教程

2024-09-19 16:44:21作者:卓艾滢Kingsley

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 构建出优秀的文档站点!

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8