Skip to content

Commit 77dbbe3

Browse files
authored
Update icons docs (#818)
* Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * fix formatting
1 parent 3f86ce4 commit 77dbbe3

File tree

4 files changed

+21
-17
lines changed

4 files changed

+21
-17
lines changed

components/icons.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Icons"
33
description: "Use icons from popular icon libraries"
4-
icon: 'flag'
4+
icon: "flag"
55
---
66

77
<Icon icon="flag" size={32} />
@@ -11,22 +11,23 @@ icon: 'flag'
1111
```mdx Icon Example
1212
<Icon icon="flag" size={32} />
1313
```
14+
1415
</RequestExample>
1516

1617
## Inline Icons
1718

1819
The icon will be placed inline when used in a paragraph.
1920

2021
```markdown Inline Icon Example
21-
<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly
22+
<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly.
2223
```
2324

24-
<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly
25+
<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly.
2526

2627
### Props
2728

2829
<ResponseField name="icon" type="string" required>
29-
A [Font Awesome](https://fontawesome.com/icons) or [Lucide](https://lucide.dev/icons) icon
30+
A [Font Awesome](https://fontawesome.com/icons) icon, [Lucide](https://lucide.dev/icons) icon, URL to an icon, or relative path to an icon.
3031
</ResponseField>
3132

3233
<ResponseField name="iconType" type="string">
@@ -39,4 +40,4 @@ The icon will be placed inline when used in a paragraph.
3940

4041
<ResponseField name="size" type="number">
4142
The size of the icon in pixels
42-
</ResponseField>
43+
</ResponseField>

navigation.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The [navigation](settings#param-navigation) property in [docs.json](settings) de
99
With proper navigation configuration, you can organize your content into a logical hierarchy that makes it easy for users to find exactly what they're looking for.
1010

1111
<Info>
12-
Do not use `api` as a title for any navigation element. The `/api` path is reserved in production and will cause pages to return 404 errors if their URLs contain `/api`.
12+
Do not use `api` as a title for any navigation element. The `/api` path is reserved in production and will cause pages to return 404 errors if their URLs contain `/api`.
1313
</Info>
1414

1515
## Pages
@@ -45,7 +45,7 @@ Pages is an array where each entry must be a reference to the path of a [page fi
4545

4646
## Groups
4747

48-
Use groups to organize your navigation into sections. Groups can be nested within each other and labeled with tags.
48+
Use groups to organize your navigation into sections. Groups can be nested within each other, labeled with tags, and styled with icons.
4949

5050
<img
5151
className="block dark:hidden pointer-events-none"
@@ -63,15 +63,18 @@ Use groups to organize your navigation into sections. Groups can be nested withi
6363
"groups": [
6464
{
6565
"group": "Getting Started",
66+
"icon": "play",
6667
"pages": [
6768
"quickstart",
6869
{
6970
"group": "Editing",
71+
"icon": "pencil",
7072
"pages": [
7173
"installation",
7274
"editor",
7375
{
7476
"group": "Nested group",
77+
"icon": "code",
7578
"pages": [
7679
"navigation",
7780
"code"
@@ -83,6 +86,7 @@ Use groups to organize your navigation into sections. Groups can be nested withi
8386
},
8487
{
8588
"group": "Writing Content",
89+
"icon": "notebook-text",
8690
"tag": "NEW",
8791
"pages": ["writing-content/page", "writing-content/text"]
8892
}
@@ -516,4 +520,4 @@ This way, you can create a very complex navigation structure that is easy to man
516520
}
517521
```
518522

519-
</CodeGroup>
523+
</CodeGroup>

pages.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Pages"
33
description: "Pages are the building blocks of your documentation"
4-
icon: 'letter-text'
4+
icon: "letter-text"
55
---
66

77
## Basics
@@ -39,7 +39,7 @@ sidebarTitle: "Short title"
3939

4040
## Icons
4141

42-
You can set an icon for your sidebar item like the one for this page. You can set icons by using the `icon` metadata.
42+
Add an icon next to your page's sidebar title by including the `icon` field in your page's frontmatter.
4343

4444
```mdx
4545
---
@@ -48,9 +48,9 @@ icon: "code"
4848
---
4949
```
5050

51-
You can set icons from [Font Awesome](https://fontawesome.com/icons) and [Lucide](https://lucide.dev/icons), depending on the [icon library setting](settings#param-icons).
51+
You can set icons from a URL, [Font Awesome](https://fontawesome.com/icons), or [Lucide](https://lucide.dev/icons). Choose your preferred icon library (Font Awesome or Lucide) with the [icon library setting](settings#param-icons).
5252

53-
You can also set the icon type for Font Awesome icons (optional). If not set, the icon type will be regular.
53+
For Font Awesome icons, you can optionally set the icon type. If not set, the icon type will be regular.
5454

5555
```mdx
5656
---
@@ -116,7 +116,6 @@ Custom Mode provides a minimalist layout by removing all elements except for the
116116
This mode offers a blank canvas, which is ideal for creating a "landing page" or any page where
117117
you want a clean, distraction-free environment.
118118

119-
120119
```mdx
121120
---
122121
mode: "custom"
@@ -128,7 +127,6 @@ mode: "custom"
128127
Center Mode removes the sidebar and the table of contents, and centers the page content. This mode is great for changelogs
129128
or any page where you want to focus on the content.
130129

131-
132130
```mdx
133131
---
134132
mode: "center"
@@ -172,4 +170,4 @@ content or in search results, but users that search for them will be shown the p
172170
---
173171
keywords: ['search', 'indexing']
174172
---
175-
```
173+
```

settings.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,12 +224,13 @@ This section contains the full reference for the docs.json file.
224224

225225
<Expandable title="Links">
226226
<ResponseField name="label" type="string" required>
227+
The display text for a link.
227228
</ResponseField>
228229
<ResponseField name="href" type="string (uri)" required>
229-
A valid path or external link
230+
A valid path or external link.
230231
</ResponseField>
231232
<ResponseField name="icon" type="string | object">
232-
The icon to be displayed in the navbar.
233+
The icon displayed for a link. Can be a URL, Font Awesome icon, or Lucide icon.
233234
</ResponseField>
234235
</Expandable>
235236
</ResponseField>

0 commit comments

Comments
 (0)