Skip to content

Commit d6ce4b5

Browse files
authored
update icon frontmatter (#1196)
1 parent 41c9146 commit d6ce4b5

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

pages.mdx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ icon: "letter-text"
55
keywords: ["tags", "tag"]
66
---
77

8-
import IconsOptional from "/snippets/icons-optional.mdx";
9-
108
Each page is an MDX file, which combines Markdown content with React components to let you create rich, interactive documentation.
119

1210
## Page metadata
@@ -30,7 +28,21 @@ Use metadata to control:
3028
A short title that displays in the sidebar navigation.
3129
</ResponseField>
3230

33-
<IconsOptional />
31+
<ResponseField name="icon" type="string">
32+
The icon to display.
33+
34+
Options:
35+
- [Font Awesome icon](https://fontawesome.com/icons) name
36+
- [Lucide icon](https://lucide.dev/icons) name
37+
- URL to an externally hosted icon
38+
- Path to an icon file in your project
39+
</ResponseField>
40+
41+
<ResponseField name="iconType" type="string">
42+
The [Font Awesome](https://fontawesome.com/icons) icon style. Only used with Font Awesome icons.
43+
44+
Options: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`.
45+
</ResponseField>
3446

3547
<ResponseField name="tag" type="string">
3648
A tag that appears next to your page title in the sidebar.

0 commit comments

Comments
 (0)