页面结构
MDN 中存在许多文档结构,用于在 MDN 文章中提供信息的一致性呈现。本文档列出了描述这些结构的文档,以便您在撰写、编辑或翻译文档时能够恰当地修改页面内容。
- 横幅和通知
横幅和通知会显示在某些页面上,尤其是在 API 参考页面上,目的是突出显示将影响内容使用方式的重要因素。例如,横幅用于强调某个接口、方法或属性已被弃用,不应在生产代码中使用,或者只能在安全上下文中使用的信息。
- 浏览器兼容性表格和浏览器兼容性数据 (BCD)
MDN 具有一种标准格式的表格,用于说明 DOM、HTML、CSS、JavaScript、SVG 等共享技术在所有浏览器中的兼容性。为了能够通过编程方式在多个项目中访问这些数据,我们构建了一个 Node.js 包,该包来自 browser-compat-data 仓库,并已发布到 npm。
- MDN 上的代码示例
在 MDN 上,您会看到许多代码示例,演示如何使用我们文档中介绍的 Web 平台功能。本文档描述了您可以在页面中添加代码示例的方法,以及可用的示例类型以及何时使用它们。
- 功能状态
功能状态大致指示了某个 Web 平台功能(例如 Web API 方法或 CSS 属性)的跨浏览器实现和标准化状态。
- 链接宏
MDN 提供了许多宏,用于创建始终最新的 MDN 内容链接。在本指南中,您将了解 MDN 交叉引用宏,您可以使用它们来包含指向另一个页面的单个链接,或指向文档所有子页面的链接列表。
- 实时示例 (EmbedLiveSample)
MDN 支持在文章中显示代码块作为实时示例,这样读者就可以同时看到源代码及其在网页上的实际显示效果。此功能使读者能够确切地理解已执行代码将产生的结果,从而使文档更具动态性和指导性。它还允许作者确信文档中的代码块具有预期的输出,并在与不同浏览器配合使用时正常工作。
- 页面类型
MDN 上会重复使用许多类型的页面。本文档描述了这些页面类型、它们的目的,并提供了每个类型的示例以及创建新页面时使用的模板。
- Polyfill
本文档概述了 MDN 关于在 JavaScript 和 Web API 的参考文档中包含 polyfill 的策略。
- 侧边栏
所有 MDN 页面都应带有侧边栏。其中大部分是通过一个系统创建的,该系统在 YAML 文件中定义数据结构,并通过 front matter 或宏将侧边栏包含到页面中。
- 规范表格
MDN 上的每个参考页面都应提供有关定义该 API 或技术的规范的信息。本文演示了这些表格的外观以及如何添加它们。
- 语法部分
MDN 参考页面的语法部分包含一个语法框,用于定义某个功能的精确语法(例如,它接受哪些参数,哪些是可选的?)。本文解释了如何为参考文章编写语法框。
- 使用宏
MDN 的构建系统是 rari 后端,它为常用任务提供了宏语法。