如何記錄 CSS 屬性
隨著 CSS 標準的不斷發展,新的屬性也在不斷新增。MDN Web Docs 上的 CSS 參考 需要及時跟進這些發展。本文提供了建立 CSS 屬性參考頁面的分步說明。
每個 CSS 屬性參考頁都遵循相同的結構。這有助於讀者更輕鬆地查詢資訊,尤其是在他們熟悉了標準的參考頁格式之後。
第一步 — 確定要編寫文件的屬性
首先,您需要找出想要編寫文件的 CSS 屬性。您可能已經注意到某個頁面缺失,或者您可能在我們的 問題列表 中看到了缺失內容的報告。有關 CSS 屬性的詳細資訊,您需要找到相關的規範(例如,W3C 規範,或用於 Gecko 或 Blink 等渲染引擎的非標準屬性的 bug 報告)。
注意: 使用 W3C 規範時,請務必使用 編輯草案(請注意左側的紅色橫幅),而不是已釋出的版本(例如,工作草案)。編輯草案始終最接近最終版本!
如果實現與規範不符,請隨時在實現 bug 中提及。可能出現以下幾種情況之一:
- 這可能是實現中的一個 bug(並且會提交一個後續 bug)。
- 這可能是由於新規範釋出延遲所致。
- 這可能是規範中的一個錯誤(在這種情況下,提交一個規範 bug 是值得的)。
第二步 — 檢查 CSS 屬性資料庫
CSS 屬性的幾個特徵,例如其語法或是否可以進行動畫處理,在多個頁面中都有提及,因此被儲存在一個臨時資料庫中。您將在頁面上使用的宏需要有關該屬性儲存在那裡的資訊,因此請首先 檢查資訊是否存在。
第三步 — 建立 CSS 屬性頁面
準備工作完成!現在我們可以新增實際的 CSS 屬性頁面了。建立新的 CSS 屬性頁面的最簡單方法是複製現有 CSS 屬性頁面的內容併為其新屬性進行編輯。要建立新頁面,請參閱我們 如何建立頁面 指南中的說明。
在建立參考頁面時,您需要新增示例。要做到這一點,請遵循有關即時示例的 教程。請記住,您正在建立的屬性頁面是針對單個屬性的,因此您新增的示例需要展示該屬性如何獨立工作,而不是整個規範如何使用。因此,list-style-type 屬性的示例應顯示使用該屬性的不同值所產生的結果,而不是如何將其與其他屬性、偽類或偽元素結合以產生漂亮的效果。教程和指南可以用於展示更多內容。
第四步 — 獲取內容審查
建立完屬性頁面後,將其作為拉取請求提交。我們的審查團隊成員將自動被分配來審查您的頁面。