操作指南

MDN Web Docs 写作指南的这一部分包含了在为 MDN Web Docs 贡献内容时完成特定任务的所有分步信息:我们如何使用 Markdown,我们如何向词汇表添加条目,我们如何移动或删除页面,等等。要了解更多关于如何贡献(通过 GitHub 进行)的信息,请参阅我们的 贡献指南

注意: 在本节中,我们假设您已阅读贡献指南,熟悉 mdn/content 代码库,并了解如何使用 Git 和 GitHub。

如何添加图像和媒体

要向文档添加图像,请将您的图像文件添加到文档的文件夹中,然后使用 Markdown 图像语法 或等效的 HTML <img> 元素在文档的 index.md 文件中引用该图像。

如何创建、移动、删除和编辑页面

本文介绍如何创建、移动、删除或编辑页面。在所有这些情况下,最好查看我们关于 我们写什么 的指南,以确认是否应采取任何这些操作,并在继续操作之前与 MDN Web Docs 聊天室 中的 MDN Web Docs 团队进行讨论。

如何记录 CSS 属性

随着 CSS 标准的发展,始终会添加新的属性。MDN Web Docs 上的 CSS 参考 需要与这些发展保持同步。本文提供了创建 CSS 属性参考页面的分步说明。

如何记录 HTTP 标头

MDN Web Docs 上的 HTTP 标头参考 记录了 HTTP 标头字段。这些是超文本传输协议 (HTTP) 中请求和响应消息标头部分的组件。它们定义了 HTTP 事务的操作参数。本文说明了如何为 HTTP 标头创建一个新的参考页面。

如何记录 Web 错误

MDN Web Docs 上的 JavaScript 错误参考 是一个项目,旨在帮助 Web 开发人员解决在 开发者控制台 中发生的错误。对于此项目,我们需要在 MDN Web Docs 上编写更多错误文档,以便我们可以向抛出消息的工具添加更多链接。本文说明了如何记录 Web 错误。

如何研究一项技术

本文提供了一些关于如何记录技术的有用信息。

如何使用结构化数据

MDN 尽可能将数据存储在定义良好的结构中。然后,这些信息将集中起来,并且可以更新一次,同时在多个地方使用。

如何编写 API 参考

本指南将引导您了解在 MDN 上编写 API 参考所需的所有知识。

如何编写词汇表条目

本文说明了如何在 MDN Web Docs 词汇表 中添加和链接条目。它还提供了关于词汇表条目布局和内容的指南。词汇表提供了您在阅读关于 Web 和 Web 开发的 MDN 内容时会遇到的所有术语、行话、缩写和首字母缩略词的定义。

如何使用 Markdown

此页面描述了我们如何使用 Markdown 在 MDN Web Docs 上编写文档。我们选择了 GitHub Flavored Markdown (GFM) 作为基线,并添加了一些扩展来支持我们在 MDN 上需要做的一些事情,而这些事情在 GFM 中并不容易得到支持。