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 指南。