Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@
keywords: ["tags", "tag"]
---

import IconsOptional from "/snippets/icons-optional.mdx";

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

## Page metadata

Every page starts with frontmatter, the YAML metadata enclosed by `---` at the beginning of a file. This metadata defines how your page appears and behaves.

Check warning on line 12 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L12

Did you really mean 'frontmatter'?

Use metadata to control:

Expand All @@ -30,7 +28,21 @@
A short title that displays in the sidebar navigation.
</ResponseField>

<IconsOptional />
<ResponseField name="icon" type="string">
The icon to display.

Options:
- [Font Awesome icon](https://fontawesome.com/icons) name
- [Lucide icon](https://lucide.dev/icons) name
- URL to an externally hosted icon
- Path to an icon file in your project
</ResponseField>

<ResponseField name="iconType" type="string">
The [Font Awesome](https://fontawesome.com/icons) icon style. Only used with Font Awesome icons.

Options: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`.
</ResponseField>

<ResponseField name="tag" type="string">
A tag that appears next to your page title in the sidebar.
Expand Down Expand Up @@ -73,7 +85,7 @@

### Custom

Custom mode provides a minimalist layout that removes all elements except for the top navbar. Custom mode is a blank canvas to create landing pages or any other unique layouts that you want to have minimal navigation elements for. Custom mode is available for all themes.

Check warning on line 88 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L88

Did you really mean 'navbar'?

```yaml
---
Expand Down Expand Up @@ -145,7 +157,7 @@

## Internal search keywords

Enhance a specific page's discoverability in the built-in search by providing `keywords` in your metadata. These keywords won't appear as part of the page content or in search results, but users that search for them will be shown the page as a result.

Check warning on line 160 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L160

Did you really mean 'discoverability'?

```yaml
---
Expand Down
Loading