Skip to content

Commit a2602c9

Browse files
Create page with guidance around banners in docs
1 parent ca08243 commit a2602c9

File tree

1 file changed

+23
-0
lines changed
  • src/content/docs/style-guide/frontmatter

1 file changed

+23
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Banner
3+
description: How to display a banner at the top of the page and when to use it.
4+
banner:
5+
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.
6+
---
7+
8+
import { Steps, FileTree } from "~/components";
9+
10+
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.
11+
12+
Only use it to alert about situations that may cause disruptions to users and take note to remove it when applicable.
13+
14+
## Example
15+
16+
```mdx wrap
17+
---
18+
title: Banner
19+
description: How to display a banner at the top of the page and when to use it.
20+
banner:
21+
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.
22+
---
23+
```

0 commit comments

Comments
 (0)