How-to guides
This section of MDN Web Docs writing guidelines contains all the step-by-step information for accomplishing specific tasks when contributing to MDN Web Docs: how we use markdown, how we add an entry to the glossary, how we move or delete pages, and more. To find out more about how to contribute (which happens through GitHub), see our contribution guidelines.
Note:
All the way through this section, we assume that you've read the contribution guidelines, are familiar with the mdn/content repository, and know how to use git and GitHub.
- How to add images and media
To add an image to a document, add your image file to the document's folder, and then reference the image from within the document's
index.mdfile using Markdown image syntax or the equivalent HTML<img>element.- How to create, move, delete, and edit pages
This article describes how to create, move, delete, or edit a page. In all these instances, it's a good idea to check our guidelines for What we write to confirm if any of these actions should be taken and discuss it with the MDN Web Docs team on the MDN Web Docs chat rooms before proceeding.
- How to document a CSS property
As the CSS standards evolve, new properties are always being added. The CSS Reference on MDN Web Docs needs to be kept up-to-date with these developments. This article provides step-by-step instructions for creating a CSS property reference page.
- How to document an HTTP header
The HTTP headers reference on MDN Web Docs documents HTTP header fields. These are components of the header section of request and response messages in the Hypertext Transfer Protocol (HTTP). They define the operating parameters of an HTTP transaction. This article explains how to create a new reference page for an HTTP header.
- How to document web errors
The JavaScript error reference on MDN Web Docs is a project to help web developers with errors occurring in the Developer Console. For this project, we need to write more error documentation on MDN Web Docs so that we can add more links to the tools where the messages are thrown. This article explains how to document the web errors.
- How to research a technology
This article gives you some handy information about approaching how to document technologies.
- How to use structured data
MDN stores data in well-defined structures when possible. This information is then centralized and can be updated once, while being used in numerous places.
- How to write an API reference
This guide takes you through all you need to know to write an API reference on MDN.
- How to write an entry in the glossary
This article explains how to add and link to entries in the MDN Web Docs glossary. It also provides guidelines about glossary entry layout and content. The glossary provides definitions for all the terms, jargon, abbreviations, and acronyms you'll come across when reading MDN content about the web and web development.
- How to write in Markdown
This page describes how we use Markdown to write documentation on MDN Web Docs. We have chosen GitHub-Flavored Markdown (GFM) as a baseline, and added some extensions to support some of the things we need to do on MDN that aren't readily supported in GFM.