MDN 贡献者操作指南
MDN Web Docs 写作指南的这一部分包含在为 MDN Web Docs 做贡献时完成特定任务的详细步骤:我们如何使用 markdown、如何向术语表添加条目、如何移动或删除页面等等。要了解如何贡献,请参阅我们的贡献指南。本文档假定您已阅读贡献指南,熟悉 mdn/content 存储库,并且知道如何使用 git 和 GitHub。
- 如何添加术语表条目
本文介绍了如何向MDN Web Docs 术语表添加条目并进行链接。它还提供了关于术语表条目布局和内容的指南。术语表提供了你在阅读 MDN 关于 Web 和 Web 开发内容时遇到的所有术语、行话、缩写和首字母缩略词的定义。
- 如何添加图片、媒体和资源
本文档介绍了如何向 MDN 上的文档页面添加图片和媒体。
- 如何创建、编辑、移动或删除页面
本文介绍了如何创建、移动、删除或编辑页面。在所有这些情况下,最好先查阅我们的我们写什么指南,以确认是否应采取任何此类操作,并在进行之前与团队在 MDN Web Docs 的沟通渠道之一进行讨论。
- 如何记录 CSS 属性
随着CSS 标准的不断发展,新属性也一直在被添加。MDN Web Docs 上的CSS 参考需要与时俱进。本文提供了创建 CSS 属性参考页面的分步说明。
- 如何记录 HTTP 标头
该HTTP 头参考文档记录了超文本传输协议(HTTP)中请求和响应消息的头部分。本文介绍了如何为 HTTP 头创建新的参考页面。
- 如何记录 Web 错误
MDN Web Docs 上的JavaScript 错误参考是一个旨在帮助 Web 开发者处理在开发者控制台中出现的错误的计划。为此,我们需要在 MDN Web Docs 上编写更多错误文档,以便可以向抛出消息的工具添加更多链接。本文介绍了如何记录 Web 错误。
- 如何研究技术
本文档提供了关于如何记录技术的实用信息。
- 如何使用结构化数据
MDN 在可能的情况下,会将数据存储在明确定义的结构中。这些信息随后被集中管理,并可以在被多次使用的情况下只更新一次。
- 如何编写 API 参考
本指南将带你了解在 MDN 上编写 API 参考所需的所有知识。
- 如何用 Markdown 编写
本文档介绍了我们在 MDN Web Docs 上使用 Markdown 编写文档的方式。我们选择了 GitHub Flavored Markdown (GFM) 作为基础,并添加了扩展来支持 MDN 所需的功能。