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>元素。 -
hidden、example-good和example-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 上,注意和警告框會分別用帶有 note 和 warning 類的 <div> 元素包裹。大多數情況下,它們的第一個段落會以一個 <strong> 包裹的 note 或 warning 文字開頭。
一月份,這種情況發生了改變——class 屬性現在應包含一個額外的 notecard 類,而粗體文字現在包含在塊頂部的標題中。
有關進一步資訊和語法指南,請參閱我們的 MDN 中的 Markdown 指南。