Skip to content
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -450,9 +450,9 @@ Controls whether clicking a navigation group navigates to its first page (`true`
}
```

- `preset`: Layout. `"classic"` (logo top left), `"headline"` (title at the top, logo bottom right), or `"minimal"` (centered text above a logo panel). Omit for the default layout. With a preset, the eyebrow always uses a monospace font.
- `preset`: Layout. `"classic"` (logo top left), `"headline"` (title at the top, logo bottom right), or `"minimal"` (centered text above a logo panel). Default: `"classic"`, or the original layout when `background` is set without a preset. With a preset, the eyebrow always uses a monospace font.
- `appearance`: `"light"` or `"dark"`. Default: the site color scheme.
- `surface`: Background style for preset thumbnails only. `"brand"` (default) tints the background and glow with the primary color hue, or uses `background.color` if set. `"neutral"` uses the site background color with no glow.
- `surface`: Background style for preset thumbnails, including the default `classic`. `"brand"` (default) tints the background and glow with the primary color hue, or uses `background.color` if set. `"neutral"` uses the site background color with no glow.
- `background`: Image path or absolute URL. On preset thumbnails, it replaces the `surface` background and glow.
- `fonts.family` (required with `fonts`): Google Fonts family name, or the name of a self-hosted font. `fonts.source`: URL or path to a self-hosted font file. `fonts.format`: `"woff"`, `"ttf"`, or `"otf"`; required with `source` (`woff2` is not supported). If the font fails to load, thumbnails use the default font.
- `eyebrow.source`: Navigation level whose name appears above the title: `"group"` (default), `"tab"`, `"dropdown"`, `"anchor"`, `"language"`, `"product"`, `"version"`, `"item"`, or `"none"` to hide it. Falls back to the group name when the page is not inside that level.
Expand Down
4 changes: 2 additions & 2 deletions organize/settings-appearance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -342,13 +342,13 @@
Thumbnail customization for social media and page previews.

<ResponseField name="thumbnails.preset" type='"classic" | "headline" | "minimal"'>
Layout for thumbnails. If not set, thumbnails use the default layout.
Layout for thumbnails. Defaults to `classic`. If you set `thumbnails.background` without a preset, thumbnails keep the original layout with your background image.

- `classic`: Logo in the top left, with the title and description below it.
- `headline`: Title and description at the top, with the logo in the bottom right.
- `minimal`: Centered title and description, with the logo in a panel at the bottom.

With a preset, the eyebrow above the title always uses a monospace font, even if you set `thumbnails.fonts`.

Check warning on line 351 in organize/settings-appearance.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-appearance.mdx#L351

Did you really mean 'monospace'?
</ResponseField>

<ResponseField name="thumbnails.appearance" type='"light" | "dark"'>
Expand All @@ -356,7 +356,7 @@
</ResponseField>

<ResponseField name="thumbnails.surface" type='"brand" | "neutral"'>
Background style for preset thumbnails. Only applies when you set `thumbnails.preset`. Defaults to `brand`.
Background style for preset thumbnails, including the default `classic` layout. Defaults to `brand`.

- `brand`: A background and glow tinted with the hue of your primary color. If you set `background.color`, thumbnails use that color as the background.
- `neutral`: Your site's background color, with no glow.
Expand Down Expand Up @@ -390,7 +390,7 @@
The navigation level whose name appears as the eyebrow. Defaults to `group`. If a page is not inside a navigation element of the chosen type, the eyebrow shows the group name instead. Set to `none` to hide the eyebrow.
</ResponseField>
<ResponseField name="style" type='"plain" | "bar" | "pill"'>
How the eyebrow is drawn on preset thumbnails. Defaults to `bar` for `classic`, `pill` for `headline`, and `plain` for `minimal`.

Check warning on line 393 in organize/settings-appearance.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-appearance.mdx#L393

In general, use active voice instead of passive voice ('is drawn').
</ResponseField>
<ResponseField name="color" type="string">
Hex color of the eyebrow on preset thumbnails. If not set, Mintlify derives the color from your theme colors.
Expand Down
4 changes: 2 additions & 2 deletions organize/settings-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -512,10 +512,10 @@

#### `thumbnails.preset`

Layout for thumbnails: `classic` places the logo in the top left, `headline` places the title at the top and the logo in the bottom right, and `minimal` centers the text above a logo panel. With a preset, the eyebrow always uses a monospace font.

Check warning on line 515 in organize/settings-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-reference.mdx#L515

Did you really mean 'monospace'?

**Type:** `"classic"` | `"headline"` | `"minimal"`
**Default:** Default layout
**Default:** `classic`, or the original layout if you set `thumbnails.background` without a preset

#### `thumbnails.appearance`

Expand All @@ -526,7 +526,7 @@

#### `thumbnails.surface`

Background style for preset thumbnails. `brand` tints the background and glow with the hue of your primary color, or uses `background.color` if you set it. `neutral` uses your site's background color with no glow. Only applies when you set `thumbnails.preset`.
Background style for preset thumbnails. `brand` tints the background and glow with the hue of your primary color, or uses `background.color` if you set it. `neutral` uses your site's background color with no glow.

**Type:** `"brand"` | `"neutral"`
**Default:** `"brand"`
Expand Down Expand Up @@ -577,7 +577,7 @@

##### `thumbnails.eyebrow.style`

How the eyebrow is drawn on preset thumbnails.

Check warning on line 580 in organize/settings-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-reference.mdx#L580

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

**Type:** `"plain"` | `"bar"` | `"pill"`
**Default:** `"bar"` for `classic`, `"pill"` for `headline`, `"plain"` for `minimal`
Expand All @@ -589,7 +589,7 @@
**Type:** string
**Default:** Derived from your theme colors

#### `thumbnail` on groups and divisions

Check warning on line 592 in organize/settings-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-reference.mdx#L592

'on groups and divisions' should use sentence-style capitalization.

Groups and navigation divisions (tabs, anchors, dropdowns, products, versions, languages, and menu items) accept a `thumbnail` object that overrides `thumbnails` for the pages inside them. Pages accept the same object in frontmatter. See [Override thumbnails for a page or section](/organize/settings-appearance#override-thumbnails-for-a-page-or-section).

Expand Down Expand Up @@ -915,7 +915,7 @@

##### `api.examples.languages`

Languages for autogenerated code snippets. See [supported languages](/api-playground/overview#all-supported-languages).

Check warning on line 918 in organize/settings-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-reference.mdx#L918

Use 'API' instead of 'api'.

**Type:** array of string

Expand Down
Loading