Skip to content

Commit 3d8c8d2

Browse files
committed
update for required/optional
1 parent c0135e2 commit 3d8c8d2

File tree

8 files changed

+17
-19
lines changed

8 files changed

+17
-19
lines changed

ai/contextual-menu.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: "square-menu"
55
---
66

77
import { PreviewButton } from "/snippets/previewbutton.jsx"
8-
import { Icons } from "/snippets/icons.jsx";
8+
import IconsRequired from "/snippets/icons-required.mdx";
99

1010
The contextual menu provides quick access to AI-optimized content and direct integrations with popular AI tools. When users select the contextual menu on any page, they can copy content as context for AI tools or open conversations in ChatGPT, Claude, Perplexity, or a custom tool of your choice with your documentation already loaded as context.
1111

@@ -55,7 +55,7 @@ Create custom options in the contextual menu by adding an object to the `options
5555
The description of the option. Displayed beneath the title when the contextual menu is expanded.
5656
</ResponseField>
5757

58-
<Icons />
58+
<IconsRequired />
5959

6060
<ResponseField name="href" type="string | object" required>
6161
The href of the option. Use a string for simple links or an object for dynamic links with query parameters.

code.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ description: "Display inline code and code blocks"
44
icon: "code"
55
---
66

7-
import { Icons } from "/snippets/icons.jsx";
8-
97
## Adding code samples
108

119
You can add inline code snippets or code blocks. Code blocks support meta options for syntax highlighting, titles, line highlighting, icons, and more.

components/accordions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Collapsible components to show and hide content"
44
icon: "chevron-down"
55
---
66

7-
import { Icons } from "/snippets/icons.jsx";
7+
import IconsOptional from "/snippets/icons-optional.mdx";
88

99
Accordions allow users to expand and collapse content sections. Use accordions for progressive disclosure and to organize information.
1010

@@ -99,4 +99,4 @@ Group related accordions together using `<AccordionGroup>`. This creates a cohes
9999
Whether the Accordion is open by default.
100100
</ResponseField>
101101

102-
<Icons />
102+
<IconsOptional />

components/cards.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Highlight main points or links with customizable layouts and icons
44
icon: "square-mouse-pointer"
55
---
66

7-
import { Icons } from "/snippets/icons.jsx";
7+
import IconsOptional from "/snippets/icons-optional.mdx";
88

99
Use cards to create visual containers for content. Cards are flexible containers that can include text, icons, images, and links.
1010

@@ -104,7 +104,7 @@ Use the [Columns component](/components/columns) to organize multiple cards side
104104
The title displayed on the card
105105
</ResponseField>
106106

107-
<Icons />
107+
<IconsOptional />
108108

109109
<ResponseField name="color" type="string">
110110
Icon color as a hex code (e.g., `#FF6B6B`).

components/icons.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Use icons from popular icon libraries"
44
icon: "flag"
55
---
66

7-
import { Icons } from "/snippets/icons.jsx";
7+
import IconsRequired from "/snippets/icons-required.mdx";
88

99
Use icons from Font Awesome, Lucide, SVGs, external URLs, or files in your project to enhance your documentation.
1010

@@ -26,7 +26,7 @@ Icons are placed inline when used within a paragraph.
2626

2727
## Properties
2828

29-
<Icons />
29+
<IconsRequired />
3030

3131
<ResponseField name="color" type="string">
3232
The color of the icon as a hex code (for example, `#FF5733`).

components/steps.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Sequence content using the Steps component"
44
icon: "list-todo"
55
---
66

7-
import { Icons } from "/snippets/icons.jsx";
7+
import IconsOptional from "/snippets/icons-optional.mdx";
88

99
Use steps to display a series of sequential actions or events. You can add as many steps as needed.
1010

@@ -50,7 +50,7 @@ Use steps to display a series of sequential actions or events. You can add as ma
5050
The content of a step either as plain text or components.
5151
</ResponseField>
5252

53-
<Icons />
53+
<IconsOptional />
5454

5555
<ResponseField name="title" type="string">
5656
The title is the primary text for the step and shows up next to the indicator.

pages.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Pages are the building blocks of your documentation"
44
icon: "letter-text"
55
---
66

7-
import { Icons } from "/snippets/icons.jsx";
7+
import IconsOptional from "/snippets/icons-optional.mdx";
88

99
Each page is an MDX file, which combines Markdown content with React components to let you create rich, interactive documentation.
1010

@@ -24,7 +24,7 @@ Every page starts with frontmatter—YAML metadata enclosed by `---` at the begi
2424
A short title that displays in the sidebar navigation.
2525
</ResponseField>
2626

27-
<Icons />
27+
<IconsOptional />
2828

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

settings.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: "settings-2"
55
keywords: ["docs.json", "settings", "customization", "configuration"]
66
---
77

8-
import { Icons } from "/snippets/icons.jsx";
8+
import IconsOptional from "/snippets/icons-optional.mdx";
99

1010
The `docs.json` file lets you turn a collection of Markdown files into a navigable, customized documentation site. This required configuration file controls styling, navigation, integrations, and more.
1111

@@ -279,7 +279,7 @@ See [Themes](themes) for more information.
279279
<ResponseField name="href" type="string (uri)" required>
280280
URL or path for the link destination.
281281
</ResponseField>
282-
<Icons />
282+
<IconsOptional />
283283
</Expandable>
284284
</ResponseField>
285285
<ResponseField name="primary" type="object">
@@ -356,7 +356,7 @@ See [Themes](themes) for more information.
356356

357357
Minimum length: 1
358358
</ResponseField>
359-
<Icons />
359+
<IconsOptional />
360360
<ResponseField name="hidden" type="boolean">
361361
Whether to hide this tab by default.
362362
</ResponseField>
@@ -374,7 +374,7 @@ See [Themes](themes) for more information.
374374

375375
Minimum length: 1
376376
</ResponseField>
377-
<Icons />
377+
<IconsOptional />
378378
<ResponseField name="color" type="object">
379379
Custom colors for the anchor.
380380

@@ -409,7 +409,7 @@ See [Themes](themes) for more information.
409409

410410
Minimum length: 1
411411
</ResponseField>
412-
<Icons />
412+
<IconsOptional />
413413
<ResponseField name="hidden" type="boolean">
414414
Whether to hide this dropdown by default.
415415
</ResponseField>

0 commit comments

Comments
 (0)