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
8 changes: 7 additions & 1 deletion pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@
title: "Pages"
description: "Pages are the building blocks of your documentation"
icon: "letter-text"
keywords: ["tags", "tag"]
---

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—YAML metadata enclosed by `---` at the beginning of your file. This metadata controls how your page appears and behaves.
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:

- Page titles and descriptions
- Sidebar titles, icons, and tags

<ResponseField name="title" type="string" required>
The title of your page that appears in navigation and browser tabs.
Expand All @@ -23,7 +29,7 @@
</ResponseField>

<ResponseField name="icon" type="string">
An icon next to your page title in the sidebar. Choose an icon from Font Awesome, Lucide, or use a custom URL. Configure your preferred icon library with the [icons library setting](/settings#param-icons).

Check warning on line 32 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L32

Did you really mean 'Lucide'?

</ResponseField>

Expand Down Expand Up @@ -68,7 +74,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.

Check warning on line 77 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L77

Did you really mean 'navbar'?

```yaml
---
Expand Down Expand Up @@ -129,7 +135,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 138 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L138

Did you really mean 'discoverability'?

```yaml
---
Expand Down
Loading