MDN Web Docs 更新日志

本文档记录了 MDN 内容流程、结构和最佳实践的变更及其发生时间。定期贡献者可以通过查阅此文档了解内容创作流程的变化。

2022 年 10 月

已更新并分为两大类,对 MDN 项目文档进行了整理:

  • 撰写:关于如何在 MDN 上撰写内容、我们记录的内容、实验性内容的定义、风格指南等信息,请参见 撰写指南页面。
  • 社区:关于开源礼仪、讨论、拉取请求和问题的处理流程、用户和团队、以及贡献者通用技巧等信息,请参见 社区页面。

有关变更的更多详细信息,请参阅 Mozilla Hacks 上发布的博文 MDN Web Docs 贡献文档改版

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 文本开头。

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

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