-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Style guide] Update banner guidance and Get started template (#17504)
* Remove word Step from headings in Get started template * Create page with guidance around banners in docs * Remove banner example from index.mdx and text-refine new page
- Loading branch information
1 parent
c2067ef
commit 055ef5e
Showing
3 changed files
with
34 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: Banner | ||
description: How to display a banner at the top of the page and when to use it. | ||
banner: | ||
content: Do <strong>not</strong> use banners in the <a href="/style-guide/frontmatter/">Frontmatter</a> unless a change will cause customer application to break. | ||
--- | ||
|
||
import { Steps, FileTree } from "~/components"; | ||
|
||
One of the fields you can add to the [Frontmatter](/style-guide/frontmatter/) is `banner`. It displays a prominent section at the top of the page and supports the use of HTML for links and formatting. | ||
|
||
Only use it to alert about disruptive situations and take note to remove it when applicable. | ||
|
||
## Example | ||
|
||
```mdx wrap | ||
--- | ||
title: Banner | ||
description: How to display a banner at the top of the page and when to use it. | ||
banner: | ||
content: Do <strong>not</strong> use banners in the <a href="/style-guide/frontmatter/">Frontmatter</a> unless a change will cause customer application to break. | ||
--- | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters