MDN Web 文档写作指南
MDN Web 文档写作指南的这一部分包含了为 MDN Web 文档做贡献时完成特定任务的所有步骤信息:我们如何使用 markdown,如何向词汇表添加条目,如何移动或删除页面,等等。要了解更多关于如何(通过 GitHub 进行)贡献的方法,请参见我们的贡献指南。
备注: 在本节中,我们假设你已经阅读了贡献指南,熟悉 mdn/content 仓库,并且知道如何使用 git 和 GitHub。
- 如何使用 markdown 来撰写文档
本文介绍了如何使用 Markdown 来编写 MDN Web 文档项目中的文档。我们以 GitHub 风格的 Markdown(GFM)为基础,并添加了一些扩展来支持一些我们在 MDN 上需要而 GFM 仍不支持的东西。
- 如何创建、移动、删除及编辑页面
本文描述了创建、移动、删除及编辑页面的方法。在所有这些情况下,最好检查我们的 MDN 收录规则页面的指导方针,以确认是否应该采取这些行动,并在采取进一步措施之前与 MDN Web 文档团队在 MDN Web 文档聊天室进行讨论。
- 如何撰写 API 参考文档
本篇指南将带你了解在 MDN 上编写 API 参考文档所需的所有知识。
- 如何撰写和引用一个术语表中的条目
本文介绍了如何撰写或引用 MDN Web 文档术语表中的条目,还提供了有关术语条目的布局和内容的指南。术语表提供了你在阅读有关 Web 和 Web 开发的 MDN 内容时会遇到的所有术语、行话和缩写的定义。