CSS property page template
Note: Remove this note block before publishing.
Page front matter:
The front matter at the top of the page is used to define "page metadata". The values should be updated appropriately for the particular property.
---
title: NameOfTheProperty
slug: Web/CSS/NameOfTheProperty
page-type: css-property OR css-shorthand-property
status:
- experimental
- deprecated
- non-standard
browser-compat: css.properties.NameOfTheProperty
---
- title
-
The
title
value is displayed at the top of the page. The title format is NameOfTheProperty. For example, thebackground-color
property has a title of background-color. - slug
-
The
slug
value is the end of the URL path afterhttps://developer.mozilla.org/en-US/docs/
. This will be formatted asWeb/CSS/NameOfTheProperty
. For example, the slug for thebackground-color
property isWeb/CSS/background-color
. For a multi-word component such asGetting_started
in a slug, the slug should use an underscore as in/en-US/docs/Learn_web_development/Core/Structuring_content
. - page-type
-
The
page-type
value for CSS properties iscss-property
. For a shorthand CSS property, the value iscss-shorthand-property
. For example, thepage-type
value for the animation property iscss-shorthand-property
because it is a shorthand property, whereas thepage-type
value for the animation-delay property iscss-property
. - status
-
Flags describing the status of this feature. An array which may contain one or more of the following:
experimental
,deprecated
,non-standard
. This key should not be set manually: it is set automatically based on values in the browser compatibility data for the feature. See "How to add or update feature statuses". - browser-compat
-
Replace the placeholder value
css.properties.NameOfTheProperty
with the query string for the property in the Browser compat data repo. Check the Other macros in the page section of this note block to see how this key-value is used to generate content for the Specifications and Browser compatibility sections.
Top-of-the-page macros
A number of macro calls appear at the top of the content section (immediately below the page front matter). These macros are automatically added by the toolchain (there is no need to add/remove):
{{SeeCompatTable}}
: This macro generates an Experimental banner, which indicates that the technology is experimental. If the technology is experimental and is hidden behind a preference in Firefox, you should also fill in an entry for it in the Experimental features in Firefox page.{{Deprecated_Header}}
: This macro generates a Deprecated banner, which indicates that the use of the technology is discouraged.{{Non-standard_Header}}
— this generates a Non-standard banner that indicates that the feature is not part of any specification.
You should update or delete the following macros according to the advice below:
{{CSSRef}}
: This macro must be present on every CSS property page. It generates a suitable CSS sidebar, depending on the tags included on the page. Remember to remove the{{MDNSidebar}}
macro when you use this template.
Do not provide status header macros manually. Refer to the section "How to add or update feature statuses" to add these statuses to the page.
Samples of the Experimental, Deprecated, and Non-standard banners are shown right after this note block.
Other macros in the page
-
Formal syntax section: The content for the Formal syntax section is generated using the
{{CSSSyntax}}
macro. This macro fetches data from the specifications using the @webref/css npm package. -
Formal definition section: The content for the Formal definition section is generated using the
{{CSSInfo}}
macro. For this section to have data, you must ensure an appropriate entry has been filled in for the corresponding property in the properties.json data file in themdn/data
repository. See the Properties page for more information. -
Specifications and Browser compatibility sections: The build tool automatically uses the
browser-compat
key-value pair from the page front matter to insert data into the Specifications and Browser compatibility sections (replacing the{{Specifications}}
and{{Compat}}
macros in those sections, respectively).Note that you may first need to create/update an entry for the property and its specification in our Browser compat data repo. See our compatibility tables guide for information on adding or editing entries.
Remember to remove this note block before publishing.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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.
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.
Begin the content on the page with an introductory paragraph, which names the property and says what it does. This should ideally be one or two short sentences.
Try it
This title is auto-generated by the macro {{EmbedInteractiveExample}}
.
This section is for interactive examples added using the {{EmbedInteractiveExample}}
macro. You create these examples in the mdn/interactive-examples repository. See the Interactive examples section in our Writing guidelines for more information.
Constituent properties
Add this section only for shorthand properties, such as animation, to list all the related longhand properties.
Syntax
Include the common use cases as a code block and describe the component subvalues that make up a complete value.
/* Insert code block showing common use cases */
/* or categories of values */
Values
Description
This is an optional section to include a description of the property and explain how it works. Use this section to explain related terms and add use cases for the property.
Formal definition
{{CSSInfo}}
To use this macro, remove the backticks and backslash in the markdown file.
Formal syntax
{{CSSSyntax}}
To use this macro, remove the backticks and backslash in the markdown file.
Accessibility
This is an optional section. Include accessibility guidelines, best practices, and potential concerns that developers should be aware of while using this property. You can also include workarounds or solutions where applicable.
Examples
Note that we use the plural "Examples" even if the page only contains one example.
Add a descriptive heading
Each example must have an H3 heading (###
) naming the example. The heading should be descriptive of what the example is doing. For example, "A simple example" does not say anything about the example and therefore, not a good heading. The heading should be concise. For a longer description, use the paragraph after the heading.
See our guide on how to add code examples for more information.
Note: Sometimes you will want to link to examples given on another page.
Scenario 1: If you have some examples on this page and some more examples on another page:
Include an H3 heading (###
) for each example on this page and then a final H3 heading (###
) with the text "More examples", under which you can link to the examples on other pages. For example:
## Examples
### Using the fetch API
Example of Fetch
### More examples
Links to more examples on other pages
Scenario 2: If you only have examples on another page and none on this page:
Don't add any H3 headings; just add the links directly under the H2 heading "Examples". For example:
## Examples
For examples of this API, see [the page on fetch()](https://example.org/).
Specifications
{{Specifications}}
To use this macro, remove the backticks and backslash in the markdown file.
Browser compatibility
{{Compat}}
To use this macro, remove the backticks and backslash in the markdown file.
See also
Include links to reference pages and guides related to the current property. For more guidelines, see the See also section in the Writing style guide.
- link1
- link2
- external_link (year)