文档结构

在 MDN 上有各式各样的可重复使用的文档结构,以使 MDN 文章中的内容有一致性的表现。这里的文章描述了这些结构。因此作为一名 MDN 的作者,你可以识别、应用并修改成适合于你撰写、编辑或翻译的文档。

代码示例

在 MDN 上,你会看到整个页面中有许多代码示例插入,以展示 web 平台功能的使用。本文讨论了在页面中添加代码示例的不同机制,以及你应该使用哪些机制和何时使用。

使用宏

为了自动化执行某些工作,Yari 平台提供了一个强大的宏系统——KumaScript。本文提供了一些相关信息,方便你在参与编辑 MDN 时使用这些宏。

侧边栏

MDN 支持在页面中添加侧边栏;这些框是包含到 MDN 上的其他页面或站外页面链接的可分层列表。本文描述了如何创建侧边栏。

兼容性表格和浏览器兼容性数据仓库(BCD)

MDN 为我们的开放 web 文档提供了兼容性表格的标准格式;它是对比所有浏览器之间,包含 DOM、HTML、CSS、JavaScript、SVG 等技术的文档。为使这些数据可以编程的方式在在多个项目中可用,我们从 browser-compat-data 仓库构建了一个 Node.js 包,并将其发布到了 npm。

横幅和通知

横幅被添加到一些页面中,特别是 API 参考页面,以突出影响所描述内容使用的重要因素。例如,横幅可以强调一个特定的接口、方法或属性被废弃,并且不应该在生产代码中使用时的情况。

规范表格

MDN 上的每一个参考页面都应该提供有关该 API 或技术定义的一个或多个规范的信息。这篇文章展示了这些表格的样子,并解释了如何添加这些表格。

语法小节

MDN 参考页面的语法小节包含一个语法框,其定义了某个特性的确切语法(例如,它可以接受哪些参数,哪些参数是可选的)。本文将解释如何编写参考页面的语法框。

运行实例

MDN 支持将文章中的示例代码转化为读者可以实际查看的在线演示。这被称为运行实例,使得用户可以查看代码的实际输出。这使得文档变得更具动态性和指导性。

页面类型

MDN 有许多复用的页面类型。本文描述了这些页面类型和它们的作用,并给出了每个页面类型的示例和创建新页面时使用的模板。