Skip to content

docs: document documentTitle frontmatter #7218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brandonmcconnell wants to merge 3 commits into
base: main
Choose a base branch
from
+13 −5
Open

docs: document documentTitle frontmatter #7218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
696de3d
docs: document documentTitle frontmatter
brandonmcconnell Sep 1, 2026
64f0b70
match sibling list punctuation and drop og:title mention
brandonmcconnell Sep 1, 2026
39ea000
Update optimize/seo.mdx
brandonmcconnell Sep 2, 2026
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
3 changes: 2 additions & 1 deletion .claude/skills/mintlify/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,10 @@ keywords: ["relevant", "search", "terms"]

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `title` | string | Yes | Page title in navigation and browser tabs. |
| `title` | string | Yes | Page title in navigation and as the on-page heading. |
| `description` | string | No | Brief description for SEO. Displays under the title. |
| `sidebarTitle` | string | No | Short title for sidebar navigation. |
| `documentTitle` | string | No | Browser tab title. Falls back to `title`. |
| `icon` | string | No | Lucide, Font Awesome, or Tabler icon name. Also accepts a URL or file path. |
| `tag` | string | No | Label next to page title in sidebar (e.g., "NEW"). |
| `hidden` | boolean | No | Remove from sidebar. Page still accessible by URL. |
Expand Down
3 changes: 2 additions & 1 deletion .claude/skills/mintlify/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ The SKILL.md file lists common frontmatter fields. Here is the complete set:

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `title` | string | Yes | Page title in navigation and browser tabs. |
| `title` | string | Yes | Page title in navigation and as the on-page heading. |
| `description` | string | No | Brief description for SEO. Displays under the title. |
| `sidebarTitle` | string | No | Short title for sidebar navigation. |
| `documentTitle` | string | No | Browser tab title. Falls back to `title`. |
| `icon` | string | No | Lucide, Font Awesome, or Tabler icon name. Also accepts a URL or file path. |
| `iconType` | string | No | Font Awesome icon style: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`. |
| `tag` | string | No | Label next to page title in sidebar (e.g., "NEW"). |
Expand Down
3 changes: 2 additions & 1 deletion optimize/seo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

**Page-specific metadata:**

- `title` - Page title, formatted as "Page Title - Site Name"
- `title` - On page H1 title and browser tab title, formatted as "Page Title - Site Name". Set `documentTitle` to change the page-title portion without changing the on-page heading

Check warning on line 31 in optimize/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/seo.mdx#L31 

Commas and periods go inside quotation marks.
- `og:title` - Open Graph title, defaults to page title
- `twitter:title` - Twitter title, falls back to `og:title`, then page title
- `description` - Page description
Expand Down Expand Up @@ -199,6 +199,7 @@
- `title` - Page title
- `description` - Page description appears below the title on the page and in some search engine results
- `canonical` - Canonical URL for this page, overrides the auto-generated canonical
- `documentTitle` - Browser tab title, site name is still appended, does not change the on-page heading
- `keywords` - Comma-separated keywords
- `og:title` - Open Graph title for social sharing
- `og:description` - Open Graph description, falls back to `description`
Expand Down
9 changes: 7 additions & 2 deletions organize/pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
Use frontmatter to control:

- Page titles and descriptions
- Sidebar titles, icons, and tags
- Sidebar titles, browser tab titles, icons, and tags
- Page layouts
- SEO meta tags
- Custom metadata

<ResponseField name="title" type="string">
The title of your page that appears in navigation and browser tabs.
The title of your page. Displays as the H1 heading and is the default for navigation, browser tabs, and social sharing titles.

If omitted, Mintlify generates a title from the path. The last segment of the path becomes the title, with dashes and underscores replaced by spaces and the first letter capitalized. For example, `guides/getting-started.md` becomes **Getting started**.
</ResponseField>
Expand All @@ -35,6 +35,10 @@
A short title that displays in the sidebar navigation.
</ResponseField>

<ResponseField name="documentTitle" type="string">
The title used in the browser tab and HTML `<title>` tag. If omitted, Mintlify uses `title` and appends your site name. The on-page heading is unchanged.

Check warning on line 39 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L39 

In general, use active voice instead of passive voice ('is unchanged').
</ResponseField>

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

Expand Down Expand Up @@ -105,6 +109,7 @@
title: "About frontmatter"
description: "Frontmatter is the metadata that controls how your page appears and behaves"
sidebarTitle: "Frontmatter"
documentTitle: "About frontmatter | Metadata"
icon: "book"
tag: "NEW"
---
Expand Down