Skip to content

docs: normalize casing in editor configurations #6178

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
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

docs: normalize casing in editor configurations #6178

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
10 changes: 5 additions & 5 deletions editor/configurations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/>
</Frame>

The panel is organized into sections that map to the top-level properties in your [`docs.json`](/organize/settings).

Check warning on line 23 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L23 

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

## General

Expand Down Expand Up @@ -79,7 +79,7 @@
Display an announcement bar across the top of every page.

- **Content**: The banner text. Supports basic MDX formatting like links, bold, and italic. Custom components are not supported.
- **dismissible**: Show a dismiss button on the right side of the banner.
- **Dismissible**: Show a dismiss button on the right side of the banner.

Check warning on line 82 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L82 

Use 'dismissible' instead of 'Dismissible'.
- **Type**: Visual style. `info` uses the primary brand color, `warning` uses an amber background, and `critical` uses a red background. Defaults to `info`.
- **Color**: Override the banner background color with a custom hex color. Set separate light and dark values for theme-aware colors.

Expand All @@ -99,7 +99,7 @@
- **Timestamps**: Show the date the content was last modified on all pages.
- **LaTeX**: Load LaTeX (KaTeX) stylesheets for mathematical notation rendering.

## Codeblocks
## Code blocks

Configure syntax highlighting and code block behavior.

Expand All @@ -117,7 +117,7 @@

Tune navigation behavior across your site.

- **drilldown**: Auto-navigate to the first page when a user clicks a navigation group.
- **Drilldown**: Auto-navigate to the first page when a user clicks a navigation group.

Check warning on line 120 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L120 

Use 'drilldown' instead of 'Drilldown'.

## Search

Expand All @@ -135,7 +135,7 @@
- **MDX server**: Custom MDX server endpoints for the API playground.
- **Playground display**: Show the interactive API playground, the simple API playground, or no API playground.
- **Proxy server**: Enable or disable the proxy server for API requests.
- **`mdx.schema`**: Whether to render the schema section on API reference pages.
- **MDX schema**: Whether to render the schema section on API reference pages.

## Redirects

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

Configure metatags and indexing for search engines.

- **metatags**: Custom `<meta>` tags applied across your site. Add key-value pairs for tags like `og:image` or `twitter:card`.
- **Metatags**: Custom `<meta>` tags applied across your site. Add key-value pairs for tags like `og:image` or `twitter:card`.

Check warning on line 177 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L177 

Use 'metatags?' instead of 'Metatags'.
- **Indexing**: Choose whether to index hidden pages.

## Analytics
Expand All @@ -187,7 +187,7 @@

Customize the experience when a user lands on a missing page.

- **Redirect to home**: When on, missing pages redirect to your home page. When off, a 404 page is shown and you can customize the title and description below.

Check warning on line 190 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L190 

In general, use active voice instead of passive voice ('is shown').
- **Title**: Heading shown on the 404 page.
- **Description**: Subheading shown on the 404 page.

Expand Down
Loading