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
9 changes: 8 additions & 1 deletion organize/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,20 @@

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.

Use metadata to control:
Use frontmatter to control:

- Page titles and descriptions
- Sidebar titles, icons, and tags
- Page layouts
- SEO meta tags

Check warning on line 18 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L18

Spell out 'SEO', if it's unfamiliar to the audience.
- Custom metadata

<ResponseField name="title" type="string" required>
The title of your page that appears in navigation and browser tabs.
</ResponseField>

<ResponseField name="description" type="string">
A brief description of what this page covers. Appears under the title and improves SEO.

Check warning on line 26 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L26

Spell out 'SEO', if it's unfamiliar to the audience.
</ResponseField>

<ResponseField name="sidebarTitle" type="string">
Expand All @@ -47,6 +50,10 @@
A tag that appears next to your page title in the sidebar.
</ResponseField>

<ResponseField name="<custom>" type="string">
Any valid YAML frontmatter. For example, `product: "API"` or `version: "1.0.0"`.
</ResponseField>

```yaml Example YAML frontmatter wrap
---
title: "About frontmatter"
Expand All @@ -63,7 +70,7 @@

### Default

If no mode is defined, defaults to a standard layout with a sidebar navigation and table of contents.

Check warning on line 73 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L73

In general, use active voice instead of passive voice ('is defined').

```yaml
---
Expand All @@ -73,7 +80,7 @@

### Wide

Wide mode hides the table of contents. This is useful for pages that do not have any headings or if you prefer to use the extra horizontal space. Wide mode is available for all themes.

Check warning on line 83 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L83

Use 'don't' instead of 'do not'.

```yaml
---
Expand Down Expand Up @@ -140,10 +147,10 @@

## Search engine optimization

Most SEO meta tags are automatically generated. You can set SEO meta tags manually to improve your site's SEO, social sharing, and browser compatibility.

Check warning on line 150 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L150

Spell out 'SEO', if it's unfamiliar to the audience.

Check warning on line 150 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L150

Spell out 'SEO', if it's unfamiliar to the audience.

Check warning on line 150 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L150

Spell out 'SEO', if it's unfamiliar to the audience.

<Note>
Meta tags with colons must be wrapped in quotes.

Check warning on line 153 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L153

In general, use active voice instead of passive voice ('be wrapped').
</Note>

```yaml
Expand All @@ -152,11 +159,11 @@
---
```

See [SEO](/optimize/seo) for complete SEO metadata options.

Check warning on line 162 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L162

Spell out 'SEO', if it's unfamiliar to the audience.

## 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 166 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L166

Avoid using 'will'.

Check warning on line 166 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L166

In general, use active voice instead of passive voice ('be shown').

```yaml
---
Expand Down