Skip to content

Document undocumented frontmatter fields, expandable prop, and locales #4576

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

Closed
mintlify wants to merge 1 commit into from
Closed

Document undocumented frontmatter fields, expandable prop, and locales #4576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion components/expandables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Expandables"

Check warning on line 2 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L2 

Use 'expandables' instead of 'Expandables'.
description: "Toggle expandable sections to show and hide nested object properties in API documentation and response fields."
keywords: ["expandables", "nested properties", "expandable fields", "toggle content"]
---
Expand Down Expand Up @@ -41,5 +41,9 @@
</ResponseField>

<ResponseField name="defaultOpen" type="boolean" default="false">
Set to `true` for the expandable to open when the page loads
Set to `true` for the expandable to open when the page loads.
</ResponseField>

<ResponseField name="lazy" type="boolean" default="false">
Set to `true` to defer rendering the expandable's children until the user first opens it. Use this for pages with many expandable sections to improve initial load performance.

Check warning on line 48 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L48 

Did you really mean 'expandable's'?
</ResponseField>
11 changes: 7 additions & 4 deletions organize/navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@

Use the `expanded` property to control the default state of a nested group in the navigation sidebar.

- `expanded: true`: Group is expanded by default.

Check warning on line 123 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L123 

In general, use active voice instead of passive voice ('is expanded').
- `expanded: false` or omitted: Group is collapsed by default.

Check warning on line 124 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L124 

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

<Note>
The `expanded` property only affects nested groups--groups within groups. Top-level groups are always expanded and cannot be collapsed.

Check warning on line 127 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L127 

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

```json
Expand Down Expand Up @@ -614,11 +614,13 @@
<Card title="Arabic (ar)" icon="/images/navigation/languages/ar.png" horizontal />
<Card title="Catalan (ca)" icon="/images/navigation/languages/ca.png" horizontal />
<Card title="Czech (cs)" icon="/images/navigation/languages/cs.png" horizontal />
<Card title="Chinese (cn)" icon="/images/navigation/languages/cn.png" horizontal />
<Card title="Chinese (zh-Hant)" icon="/images/navigation/languages/cn.png" horizontal />
<Card title="Chinese (cn or zh)" icon="/images/navigation/languages/cn.png" horizontal />
<Card title="Chinese, Simplified (zh-Hans)" icon="/images/navigation/languages/cn.png" horizontal />
<Card title="Chinese, Traditional (zh-Hant)" icon="/images/navigation/languages/cn.png" horizontal />
<Card title="Dutch (nl)" icon="/images/navigation/languages/nl.png" horizontal />
<Card title="English (en)" icon="/images/navigation/languages/en.png" horizontal />
<Card title="French (fr)" icon="/images/navigation/languages/fr.png" horizontal />
<Card title="French, Canadian (fr-CA)" icon="/images/navigation/languages/fr.png" horizontal />
<Card title="German (de)" icon="/images/navigation/languages/de.png" horizontal />
<Card title="Hebrew (he)" icon="/images/navigation/languages/he.png" horizontal />
<Card title="Hindi (hi)" icon="/images/navigation/languages/hi.png" horizontal />
Expand All @@ -630,13 +632,14 @@
<Card title="Latvian (lv)" icon="/images/navigation/languages/lv.png" horizontal />
<Card title="Norwegian (no)" icon="/images/navigation/languages/no.png" horizontal />
<Card title="Polish (pl)" icon="/images/navigation/languages/pl.png" horizontal />
<Card title="Portuguese (pt-BR)" icon="/images/navigation/languages/pt-br.png" horizontal />
<Card title="Portuguese (pt)" icon="/images/navigation/languages/pt.png" horizontal />
<Card title="Portuguese, Brazilian (pt-BR)" icon="/images/navigation/languages/pt-br.png" horizontal />
<Card title="Romanian (ro)" icon="/images/navigation/languages/ro.png" horizontal />
<Card title="Russian (ru)" icon="/images/navigation/languages/ru.png" horizontal />
<Card title="Spanish (es)" icon="/images/navigation/languages/es.png" horizontal />
<Card title="Swedish (sv)" icon="/images/navigation/languages/sv.png" horizontal />
<Card title="Turkish (tr)" icon="/images/navigation/languages/tr.png" horizontal />
<Card title="Ukrainian (ua)" icon="/images/navigation/languages/ua.png" horizontal />
<Card title="Ukrainian (uk)" icon="/images/navigation/languages/ua.png" horizontal />
<Card title="Uzbek (uz)" icon="/images/navigation/languages/uz.png" horizontal />
<Card title="Vietnamese (vi)" icon="/images/navigation/languages/vi.png" horizontal />
</CardGroup>
Expand Down Expand Up @@ -950,9 +953,9 @@

</CodeGroup>

## Breadcrumbs

Check warning on line 956 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L956 

Use 'breadcrumbs?' instead of 'Breadcrumbs'.

Breadcrumbs display the full navigation path at the top of pages. Some themes have breadcrumbs enabled by default and others do not. You can control whether breadcrumbs display on your site using the `styling` property in your `docs.json`.

Check warning on line 958 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L958 

Use 'breadcrumbs?' instead of 'Breadcrumbs'.

<CodeGroup>

Expand Down
20 changes: 20 additions & 0 deletions organize/pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<ResponseField name="title" type="string">
The title of your page that appears in navigation and browser tabs.

If omitted, Mintlify generates a title from the file 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**.

Check warning on line 24 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L24 

Use 'path' instead of 'file path'.
</ResponseField>

<ResponseField name="description" type="string">
Expand Down Expand Up @@ -65,6 +65,14 @@
Set to `true` to display a "deprecated" label next to the page title. Use this to mark outdated content or legacy features while keeping the page accessible.
</ResponseField>

<ResponseField name="hideFooterPagination" type="boolean">
Set to `true` to hide the previous/next page navigation links at the bottom of the page. Use this for standalone pages that don't belong to a sequential reading flow.
</ResponseField>

<ResponseField name="hideApiMarker" type="boolean">
Set to `true` to hide the API method badge (e.g., GET, POST) next to the page title in the sidebar. Use this for API pages where you want a cleaner sidebar appearance.

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 

Use 'for example' instead of 'e.g.'.
</ResponseField>

<ResponseField name="<custom>" type="string">
Any valid YAML frontmatter. For example, `product: "API"` or `version: "1.0.0"`.
</ResponseField>
Expand Down Expand Up @@ -210,3 +218,15 @@
```

If you set `timestamp: true`, the page always shows the timestamp even if the global setting is `false`. If you set `timestamp: false`, the page hides the timestamp even if the global setting is `true`.

### Manual dates

You can manually set the last-updated and creation dates for a page with frontmatter fields. These override the automatically detected dates from your version control system.

```yaml
---
title: "Page title"
lastUpdatedDate: "2025-01-15"
createdDate: "2024-06-01"
---
```
Loading