This page lists many of the general-purpose macros created for use on MDN. For additional how-to information on using these macros, see Using macros.
See Other macros for information on macros that are infrequently used, are used only in special contexts, or are deprecated.
MDN provides a number of link macros for easing the creation of links to reference pages, glossary entries, and other topics.
Link macros are recommended over normal Markdown links because they are succinct and translation-friendly. For example a glossary or reference link created using a macro does not need to be translated: in other locales it will automatically link to the correct version of the file.
The macros are easy to use. Minimally all you need to do is specify the name of the item to link to in the first argument. Most macros will also take a second argument allowing you to change the display text (documentation can be found at the links in the left-most column below).
|Macro||Links to page under||Example|
|CSSxRef||CSS Reference (/Web/CSS/Reference)||
|DOMxRef||DOM Reference (/Web/API)||
You can change the display text using a second parameter:
|HTMLElement||HTML Elements reference (/Web/HTML/Element)||
|SVGAttr||SVG attribute reference (/Web/SVG/Attribute).||
|SVGElement||SVG Element reference (/Web/SVG/Element).||
||HTTP headers (/Web/HTTP/Headers).||
|HTTPMethod||HTTP request methods (/Web/HTTP/Methods).||
|HTTPStatus||HTTP response status codes (/Web/HTTP/Status)||
PreviousNext provide navigation controls for articles which are part of sequences.
For the single-way templates, the only parameter needed is the wiki location of the previous or next article in the sequence.
PreviousNext, the two parameters needed are the wiki locations of the appropriate articles.
The first parameter is for the previous article and the second is for the next article.
EmbedLiveSamplelets you embed the output of a code sample on a page, as described in Live samples.
LiveSampleLinkcreates a link to a page containing the output of a code sample on a page, as described in Live samples.
EmbedGHLiveSampleallows to embed live samples from GitHub pages. You can get more information at GitHub live samples.
There are templates for almost every large collection of pages. They typically link back to the main page of the reference/guide/tutorial (this is often needed because our breadcrumbs sometimes can't do this) and put the article in the appropriate category.
non-standard_inline inserts an in-line mark indicating the API has not been standardized and is not on a standards track.
- Icon: Non-standard
experimental_inline inserts an in-line mark indicating the API is not widely implemented and may change in the future.
For more information on the definition experimental, see the Experimental, deprecated, and obsolete documentation.
- Icon: Experimental
deprecated_inline inserts an in-line deprecated mark (
) to discourage the use of an API that is officially deprecated (or has been removed).
For more information on the definition deprecated, see the Experimental, deprecated, and obsolete documentation.
- Icon: Deprecated
These templates have the same semantics as their inline counterparts described above. The templates should be placed directly underneath the main page title (or breadcrumb navigation if available) in the reference page. They can also be used to mark up a section on a page.
Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.
SeeCompatTableshould be used on pages that document experimental features. Example:
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
secureContext_header. Should be used on main pages like interface pages, API overview pages, and API entry points (e.g.
navigator.xyz) but usually not on sub-pages like method and property pages. Example:
AvailableInWorkers macro inserts a localized note box indicating that a feature is available in a Web worker context.
You can use the argument
notservice to indicate that a feature works in web workers except for service workers.
Note: This feature is available in Web Workers