MDN Web Docs 变更日志

本文档记录了 MDN 内容流程、结构和最佳实践的变更以及变更时间。它有助于定期贡献者查看并了解有关创建 MDN 内容流程的变更。

2022 年 10 月

MDN 项目文档 已更新并组织在两个主要类别下

  • 写作:有关如何为 MDN 写作、我们记录的内容、实验性定义、样式指南等的文档可以在 写作指南 页面下找到。
  • 社区:有关开源礼仪、讨论、拉取请求和问题的处理流程、用户和团队以及针对贡献者的通用提示的信息可以在 社区 页面下找到。

有关变更的更多详细信息,请参阅 MDN Web Docs 贡献文档的更新 博客文章,该文章发布在 Mozilla Hacks 上。

2021 年 11 月

已完成转换为 Markdown,因此删除旧的 CSS 样式指南并重定向到 MDN 页面中的 Markdown。

2021 年 7 月

更新 Markdown 的 CSS 样式指南

对 CSS 样式指南进行多次更新,以反映向 Markdown 的迁移,并鼓励作者以 Markdown 兼容的方式编写 HTML。

  • 注意和警告框不再具有用于标题的单独 <h4> 标题(例如 <h4>警告</h4>)。有关正确语法的详细信息,请参阅我们的 MDN 中的 Markdown 指南。
  • 不再使用 seoSummary 类。
  • 不再使用 standard-table 类。现在默认情况下将此类提供的样式应用于表格。
  • 不再使用 <details> 元素。
  • hiddenexample-goodexample-bad 类以前主要用于代码块,但也可以用于其他元素。现在它们只能用于代码块。

2021 年 2 月

多行 JavaScript 和 API 语法块

以前,可以以多种不同方式使用(即各种参数是可选的)的 JavaScript 内置函数和 WebAPI 方法的语法块通常使用 BNF 形式语法表示法 编写。最值得注意的是,方括号用于表示可选参数。

这存在问题 - 许多开发人员对此感到困惑,并且它与其他编程语言中的有效语法形式冲突(例如,[] 也是 JavaScript 中的数组)。

因此,我们现在将在语法块内用单独的行编写方法的多种语法形式。有关更多信息和示例,请参阅 语法部分 > 多行/可选参数

记录 mixin

Web IDL 中的 接口 mixin 用于规范中定义 Web API。对于 Web 开发人员,它们无法直接观察到;它们充当助手,以避免重复 API 定义。

以前,我们通常为 mixin 类本身定义一个登录页面,并将定义的成员放在其下的子页面上,然后再从实现这些 mixin 的接口的登录页面链接到这些子页面。这对读者来说令人困惑,因为 mixin 是规范结构 - 您永远不会使用 mixin 类访问定义的成员。为了避免这种困惑,我们现在将定义在 mixin 上的成员的页面直接放在实现类的页面下。有关更多详细信息,请参阅有关 如何编写 API 参考 的指南页面,以及在 mdn/content#1940 中进行的有关此变更的讨论。

2021 年 1 月

注意和警告框的标记

以前在 MDN 上,注意和警告框将被分别使用 notewarning 类的 <div> 元素包裹。大多数情况下,它们的第一个段落将以 <strong> 包裹的 notewarning 文本开头。

在 1 月份,这种情况发生了变化 - 现在 class 属性应包含一个额外的 notecard 类,并且粗体文本现在包含在块顶部的标题中。

有关更多信息和语法指南,请参阅我们的 MDN 中的 Markdown 指南。