MDN Web 文档写作指南
MDN Web 文档写作指南的这一部分包含了为 MDN Web 文档做贡献时完成特定任务的所有步骤信息:我们如何使用 markdown,如何向词汇表添加条目,如何移动或删除页面,等等。要了解更多关于如何(通过 GitHub 进行)贡献的方法,请参见我们的贡献指南。
备注:
在本节中,我们假设你已经阅读了贡献指南,熟悉 mdn/content
仓库,并且知道如何使用 git 和 GitHub。
- 如何使用 Markdown 来撰写文档
本文介绍了如何使用 Markdown 来编写 MDN Web 文档项目中的文档。我们以 GitHub 风格的 Markdown(GFM)为基础,并添加了一些扩展来支持一些我们在 MDN 上需要而 GFM 仍不支持的东西。
- 如何使用结构化数据
MDN 尽可能以明确定义的结构存储数据。这些信息将被集中存储和更新,以便同时在多个地方使用。
- 如何创建、移动、删除及编辑页面
本文描述了创建、移动、删除及编辑页面的方法。在所有这些情况下,最好检查我们的 MDN 收录规则页面的指导方针,以确认是否应该采取这些行动,并在采取进一步措施之前与 MDN Web 文档团队在 MDN Web 文档聊天室进行讨论。
- 如何撰写 API 参考文档
本篇指南将带你了解在 MDN 上编写 API 参考文档所需的所有知识。
- 如何撰写和引用一个术语表中的条目
本文介绍了如何撰写或引用 MDN Web 文档术语表中的条目,还提供了有关术语条目的布局和内容的指南。术语表提供了你在阅读有关 Web 和 Web 开发的 MDN 内容时会遇到的所有术语、行话和缩写的定义。
- 如何添加图像和媒体
要在文档中添加图像,请将图像文件添加到该文档的文件夹中,然后在文档的
index.md
文件中使用 Markdown 图像语法或等效的 HTML<img>
元素引用该图像。- 如何研究一项技术
本文提供有关如何记录各种技术的实用信息。
- 如何记录 CSS 属性
新的属性随着 CSS 标准的发展而不断添加。MDN Web 文档上的 CSS 参考需要紧跟其发展。本文提供了创建 CSS 属性参考页面的步骤说明。
- 如何记录 HTTP 标头
MDN Web 文档上的 HTTP 标头参考记录了 HTTP 标头字段。这是超文本传输协议(HTTP)请求和响应消息的标头的组成部分。它们定义了 HTTP 事务的操作参数。本文介绍如何为 HTTP 标头创建新的参考页面。
- 如何记录 web 错误
MDN Web 文档中的 JavaScript 错误参考是一个帮助 web 开发人员处理开发者工具中出现的错误的项目。对于该项目,我们需要在 MDN Web 文档中编写更多的错误文档,以便我们可以在抛出消息的工具中添加更多的链接。本文介绍了如何记录 web 错误。