Skip to content

Add variables property to docs.json reference #3870

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

Merged
lindsayzhng merged 1 commit into from
Feb 27, 2026
+20 −0
Merged

Add variables property to docs.json reference #3870

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
20 changes: 20 additions & 0 deletions organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,26 @@
</Expandable>
</ResponseField>

<ResponseField name="variables" type="object">
Global variables for use throughout your documentation. Variables use `{{variableName}}` syntax and are replaced at build time.

Check warning on line 351 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L351 

In general, use active voice instead of passive voice ('are replaced').

```json
"variables": {
"version": "1.0.0",
"api-url": "https://api.example.com"
}
```

Reference variables in your MDX content:

```mdx
The current version is {{version}}.
Make requests to {{api-url}}/v1/users.
```

Variable names can contain alphanumeric characters, hyphens, and periods. Values are sanitized to prevent XSS attacks. Undefined variables remain as literal text.

Check warning on line 367 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L367 

In general, use active voice instead of passive voice ('are sanitized').

Check warning on line 367 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L367 

Use 'undefined' instead of 'Undefined'.
</ResponseField>

### Structure

<ResponseField name="navbar" type="object">
Expand Down Expand Up @@ -649,7 +669,7 @@
Destination path to redirect to. Example: `/new-page`
</ResponseField>
<ResponseField name="permanent" type="boolean">
Whether to use a permanent redirect (301). Defaults to `true`.

Check warning on line 672 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L672 

Use parentheses judiciously.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down