Skip to content

Commit 15fb6c0

Browse files
docs: add beta banner frontmatter property documentation
Add documentation for the new beta frontmatter property that displays a yellow warning banner on pages to indicate beta/work-in-progress content. Co-Authored-By: Deep Singhvi <[email protected]>
1 parent b5d13f0 commit 15fb6c0

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

fern/products/docs/pages/customization/frontmatter.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,29 @@ hide-feedback: true
213213
<img src="./on-page-feedback.png" alt="Leave feedback feature" />
214214
</Frame>
215215

216+
## Beta banner
217+
<ParamField path="beta" type="boolean | string" required={false} default={false}>
218+
Displays a yellow warning banner at the top of the page to indicate that the content is in beta or still being worked on. Set to `true` for a default message, or provide a custom message string.
219+
</ParamField>
220+
221+
<CodeBlock title="Example beta banner with default message">
222+
```mdx
223+
---
224+
title: New Feature Documentation
225+
beta: true
226+
---
227+
```
228+
</CodeBlock>
229+
230+
<CodeBlock title="Example beta banner with custom message">
231+
```mdx
232+
---
233+
title: Experimental API
234+
beta: This API is experimental and may change without notice.
235+
---
236+
```
237+
</CodeBlock>
238+
216239
## Page logo
217240
<ParamField path="logo" type="object" required={false}>
218241
Override the site-wide logo for a page. Specify different logos for light and dark modes using absolute URLs.

0 commit comments

Comments
 (0)