頁面結構
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 後端,它為常用任務提供了宏語法。