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
2 changes: 1 addition & 1 deletion core-concepts/ai-ingestion.mdx → ai-ingestion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Add **.md** to an individual docs page to see a markdown version of that page. H

### contextual menu

You can enable a [contextual menu](/core-concepts/settings#param-contextual) to allow users to copy markdown source, view markdown source, or open ChatGPT with the page content.
You can enable a [contextual menu](settings#param-contextual) to allow users to copy markdown source, view markdown source, or open ChatGPT with the page content.

### ⌘ \+ c shortcut

Expand Down
6 changes: 3 additions & 3 deletions api-playground/mdx/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js
}
```

Find a full list of API configurations [here](/core-concepts/settings#param-api).
Find a full list of API configurations [here](settings#param-api).
</Step>

<Step title="Create your endpoint pages">
Expand All @@ -53,7 +53,7 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js

<Note>

If you have `server` configured in [docs.json](/core-concepts/settings), you can use relative paths like `/v1/endpoint`.
If you have `server` configured in [docs.json](settings), you can use relative paths like `/v1/endpoint`.

</Note>

Expand All @@ -69,6 +69,6 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js
</Step>

<Step title="Add your endpoints to your docs">
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs [here](/core-concepts/navigation).
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs [here](navigation).
</Step>
</Steps>
4 changes: 2 additions & 2 deletions api-playground/openapi/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
If you have multiple OpenAPI files, include the path to the OpenAPI file to ensure Mintlify finds the correct OpenAPI document. This is not required if you have
only one OpenAPI file - it will automatically detect your OpenAPI file.

If you want to reference an external OpenAPI file using this method, provide the file’s URL in the docs.json. See [here](https://mintlify.com/docs/core-concepts/settings#param-source-4) for the correct format.
If you want to reference an external OpenAPI file using this method, provide the file’s URL in the docs.json. See [here](https://mintlify.com/docssettings#param-source-4) for the correct format.

<CodeGroup>
```md Example
Expand All @@ -108,12 +108,12 @@
and the correct method will be generated.
</Note>

### Autogenerate files

Check warning on line 111 in api-playground/openapi/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/openapi/setup.mdx#L111

Did you really mean 'Autogenerate'?

For large OpenAPI documents, creating one MDX page for each OpenAPI operation can be a lot of work. To make it easier, we created a local OpenAPI page scraper.

Our Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping)
autogenerates MDX files for your OpenAPI endpoints.

Check warning on line 116 in api-playground/openapi/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/openapi/setup.mdx#L116

Did you really mean 'autogenerates'?

Each generated page will correspond to an OpenAPI operation under the "paths" section of the OpenAPI schema.
If your OpenAPI document is version 3.1+, the scraper will also generate pages for webhooks under the "webhooks" section of the OpenAPI schema.
Expand All @@ -133,12 +133,12 @@
Learn more about our scraping package [here](https://www.npmjs.com/package/@mintlify/scraping).

The scraper will output an array of
[Navigation entries](/core-concepts/settings#structure) containing your OpenAPI MDX
[Navigation entries](settings#structure) containing your OpenAPI MDX
files. You can either append these entries to your existing Navigation, or
reorder and add the files to your navigation manually.

<Note>
If your OpenAPI document is invalid, the files will not autogenerate.

Check warning on line 141 in api-playground/openapi/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/openapi/setup.mdx#L141

Did you really mean 'autogenerate'?
</Note>


Expand Down
2 changes: 1 addition & 1 deletion api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Here's a list of common issues we've seen customers run into:
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
allow `POST` requests to the `/api/request` path.

Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described [here](/core-concepts/settings#api-configurations). This will
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described [here](settings#api-configurations). This will
likely require you to configure CORS on your server, as these requests will now come directly
from your users' browsers.
</Accordion>
Expand Down
14 changes: 7 additions & 7 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@
<Frame>
![AI Translations graphic](/images/changelog/translations.png)
</Frame>
Translate all of your documentation with AI. [Learn more.](/core-concepts/navigation#localization)
Translate all of your documentation with AI. [Learn more.](navigation#localization)

## Export docs to PDF in beta

Export all of your documentation, a subdirectory, or a singe page as a PDF.

## React hook support

Bring interactivity to your docs. All standard React hooks are automatically available in your MDX files. [Learn more.](/core-concepts/react-components)
Bring interactivity to your docs. All standard React hooks are automatically available in your MDX files. [Learn more.](react-components)
</Update>

<Update label="March 2025">
Expand All @@ -55,7 +55,7 @@
![screenshot of MCP server generator](/images/changelog/mcpgenerator.png)
</Frame>
Generate MCP servers so that AI applications can interact with your docs or APIs. Written content is automatically generated as an MCP server, and you can generate an MCP server from your OpenAPI spec with one click.
Check out [docs on getting started with MCP.](/advanced/mcp/quickstart)
Check out [docs on getting started with MCP.](/mcp)

## Improvements

Expand All @@ -70,7 +70,7 @@
- Improved styling nits for dashboard border for mobile-tablet-desktop responsiveness
- Show code examples even when in simple mode for API playground
- Support "command \+ k" shortcut for search in web editor
- Codeblocks within callouts expand to fill the width of the callout area

Check warning on line 73 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L73

Did you really mean 'Codeblocks'?

Check warning on line 73 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L73

Did you really mean 'callouts'?

Check warning on line 73 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L73

Did you really mean 'callout'?
</Update>

<Update label="February 2025">
Expand Down Expand Up @@ -101,16 +101,16 @@

Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).

## .md support for LLMs

Check warning on line 104 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L104

Did you really mean 'LLMs'?

All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.

Check warning on line 106 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L106

Did you really mean 'LLMs'?

## More Themes

<Frame>
![graphic with text "Themes v2"](/images/changelog/themes.png)
</Frame>
New [pre-built themes](/core-concepts/themes) to modify the look & feel of your docs. Configure via your [docs.json file](/core-concepts/settings).
New [pre-built themes](themes) to modify the look & feel of your docs. Configure via your [docs.json file](settings).

Now available:

Expand All @@ -121,7 +121,7 @@
## Other improvements

- [Guide to Technical Writing:](https://mintlify.com/guides/introduction)Best practices for writing technical documentation, including audience research, content types, and writing tips.
- [Dropdown component](/core-concepts/navigation#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors.
- [Dropdown component](navigation#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors.
- [AI syntax fixer](https://x.com/ricardonunez_io/status/1892334887644123192): The web editor will catch if there’s a parsing error and use AI to suggest fixes.
</Update>

Expand Down Expand Up @@ -185,7 +185,7 @@
<Frame>
![llms.txt support](/images/changelog/llms.jpg)
</Frame>
All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

Check warning on line 188 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L188

Did you really mean 'LLMs'?

## Localization

Expand Down Expand Up @@ -257,7 +257,7 @@
## Dashboard Improvements

- Added ability to change custom domain to be /docs directly through dashboard settings.
- Consolidated the login and signup pages to decrease friction and confusion.

Check warning on line 260 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L260

Did you really mean 'signup'?
- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.
- Added login with Google OAuth
- Added ability to add new deployment through dashboard settings.
Expand All @@ -271,7 +271,7 @@
- Don't allow search engines to crawl user-auth protected pages.
- Revalidate the cache when an org is deleted.
- We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.
- Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.

Check warning on line 274 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L274

Did you really mean 'autogenerated'?
- Add in-line-style support for icons
- Fixed the pop-in of custom CSS in docs.
- Properly show in-line code styling in conjunction with links.
Expand Down Expand Up @@ -338,11 +338,11 @@

## File Uploads in API Playground

By default, API playground requests are proxied by Mintlify. Now you can use

Check warning on line 341 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L341

Did you really mean 'proxied'?
`disableProxy` to disable this behavior and support request types like file
uploads.

- [Learn more about API configurations](/core-concepts/settings#api-configurations)
- [Learn more about API configurations](settings#api-configurations)

## Mobile SEO improvements

Expand Down Expand Up @@ -371,7 +371,7 @@
</Frame>
For `Pro` users, we introduced Mintlify Widget, an extension of your docs to
answer your users' questions when and where they asked. You can add this
AI-powered chatbot to any web page: your landing page, inside your product, or

Check warning on line 374 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L374

Did you really mean 'chatbot'?
on your existing documentation pages.

- [Read the blog announcement](https://mintlify.com/blog/widget)
Expand Down Expand Up @@ -406,7 +406,7 @@
<Update label="May 2024">
## Okta SSO

We now support sign-on via Okta SAML and OIDC.

Check warning on line 409 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L409

Did you really mean 'Okta'?

## Mintlify REST API

Expand All @@ -423,13 +423,13 @@
- Add full-screen videos or image galleries
- Embed custom iFrame demo elements to add intractability to your docs

Check out our [Custom Mode docs](/core-concepts/pages#custom-mode).
Check out our [Custom Mode docs](pages#custom-mode).
</Update>

<Update label="March 2024">
## Mintlify MDX for VSCode

Call snippets of our pre-built components and callouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).

Check warning on line 432 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L432

Did you really mean 'callouts'?
</Update>

<Update label="February 2024">
Expand All @@ -438,7 +438,7 @@
- Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
- Versioning with tabs fully supported
- Wildcard redirects now supported
- CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development

Check warning on line 441 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L441

Did you really mean 'frontmatter'?
</Update>

<Update label="January 2024">
Expand Down
14 changes: 7 additions & 7 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@
{
"group": "Core Concepts",
"pages": [
"core-concepts/settings",
"core-concepts/pages",
"core-concepts/navigation",
"core-concepts/themes",
"core-concepts/react-components",
"core-concepts/ai-ingestion"
"settings",
"pages",
"navigation",
"themes",
"react-components",
"ai-ingestion"
]
},
{
Expand Down Expand Up @@ -111,7 +111,7 @@
"settings/gitlab",
"settings/ci",
"settings/preview-deployments",
"core-concepts/custom-scripts",
"settings/custom-scripts",
"mcp",
{
"group": "Integrations",
Expand Down
4 changes: 2 additions & 2 deletions core-concepts/navigation.mdx → navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Structure and customize your documentation's navigation hierarchy"
icon: "map"
---

The [navigation](/core-concepts/settings#param-navigation) property in [docs.json](/core-concepts/settings) defines how users will browse through your documentation. Think of it as the blueprint for your documentation's menu structure.
The [navigation](settings#param-navigation) property in [docs.json](settings) defines how users will browse through your documentation. Think of it as the blueprint for your documentation's menu structure.

With proper navigation configuration, you can organize your content into a logical hierarchy that makes it easy for users to find exactly what they're looking for.

Expand All @@ -15,7 +15,7 @@ Pages are the most fundamental navigation component.
<img className="block dark:hidden pointer-events-none" src="/images/navigation/pages-light.png" />
<img className="hidden dark:block pointer-events-none" src="/images/navigation/pages-dark.png" />

Pages is an array where each entry must be a reference to the path of a [page file](/core-concepts/pages).
Pages is an array where each entry must be a reference to the path of a [page file](pages).

```json
{
Expand Down
2 changes: 1 addition & 1 deletion core-concepts/pages.mdx → pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ icon: "code"
---
```

You can set icons from [Font Awesome](https://fontawesome.com/icons) and [Lucide](https://lucide.dev/icons), depending on the [icon library setting](/core-concepts/settings#param-icons).
You can set icons from [Font Awesome](https://fontawesome.com/icons) and [Lucide](https://lucide.dev/icons), depending on the [icon library setting](settings#param-icons).

You can also set the icon type for Font Awesome icons (optional). If not set, the icon type will be regular.

Expand Down
4 changes: 2 additions & 2 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,10 @@ Enter your domain (e.g., docs.yourcompany.com) and follow the provided instructi

Congratulations! You've successfully deployed your documentation site with Mintlify. Here are some suggested next steps to enhance your documentation:

<Card title="Customize Your Theme" icon="paintbrush" href="/core-concepts/themes" horizontal>
<Card title="Customize Your Theme" icon="paintbrush" href="themes" horizontal>
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
</Card>
<Card title="Organize Navigation" icon="map" href="/core-concepts/navigation#overview" horizontal>
<Card title="Organize Navigation" icon="map" href="navigation#overview" horizontal>
Structure your documentation with intuitive navigation to help users find what they need.
</Card>
<Card title="Add Interactive Components" icon="puzzle" href="/components/accordions" horizontal>
Expand Down
File renamed without changes.
16 changes: 8 additions & 8 deletions core-concepts/settings.mdx → settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This section contains the full reference for the docs.json file.
<ResponseField name="theme" required>
One of the following: `mint`, `maple`, `palm`, `willow`, `linden`, `almond`.

The layout theme of the project. Check out the [Themes](/core-concepts/themes) page for more information.
The layout theme of the project. Check out the [Themes](themes) page for more information.
</ResponseField>

<ResponseField name="name" type="string" required>
Expand Down Expand Up @@ -369,32 +369,32 @@ This section contains the full reference for the docs.json file.
</Expandable>
</ResponseField>
<ResponseField name="languages" type="array of object">
Organizing by [languages](/core-concepts/navigation#localization)
Organizing by [languages](navigation#localization)

</ResponseField>
<ResponseField name="versions" type="array of object">
Organizing by [versions](/core-concepts/navigation#versions)
Organizing by [versions](navigation#versions)

</ResponseField>
<ResponseField name="tabs" type="array of object">
Organizing by [tabs](/core-concepts/navigation#divisions#tabs)
Organizing by [tabs](navigation#divisions#tabs)

</ResponseField>
<ResponseField name="anchors" type="array of object">
Organizing by [anchors](/core-concepts/navigation#divisions#anchors)
Organizing by [anchors](navigation#divisions#anchors)

</ResponseField>

<ResponseField name="dropdowns" type="array of object">
Organizing by [dropdowns](/core-concepts/navigation#divisions#dropdowns)
Organizing by [dropdowns](navigation#divisions#dropdowns)

</ResponseField>
<ResponseField name="groups" type="array of object">
Organizing by [groups](/core-concepts/navigation#pages#pages)
Organizing by [groups](navigation#pages#pages)

</ResponseField>
<ResponseField name="pages" type="array of string or object">
An array of [page paths or groups](/core-concepts/navigation#pages#groups)
An array of [page paths or groups](navigation#pages#groups)

</ResponseField>

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions settings/seo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The platform automatically generates most meta tags.

However, you can fully customize them by adding the [metadata](/core-concepts/settings#param-metadata) field to your `docs.json` or the page's frontmatter.
However, you can fully customize them by adding the [metadata](settings#param-metadata) field to your `docs.json` or the page's frontmatter.

Check warning on line 9 in settings/seo.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/seo.mdx#L9

Did you really mean 'frontmatter'?



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

## Disabling indexing

If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](/core-concepts/pages) of your page:
If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](pages) of your page:

```
---
Expand Down
2 changes: 1 addition & 1 deletion core-concepts/themes.mdx → themes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export const ThemeCard = ({ title, value, description, href }) => {
<div className="pt-10 pb-24 px-4 px-4 max-w-3xl mx-auto prose prose-gray">
<label className="eyebrow h-5 text-primary dark:text-primary-light text-sm font-semibold">Core Concepts</label>
<h1 className="mt-1 mb-2 text-2xl sm:text-3xl text-gray-900 tracking-tight dark:text-gray-200 font-semibold">Themes</h1>
<label className="text-lg prose prose-gray dark:prose-invert">Custom the appearance of your documentation<br /><br />Configure [theme](/core-concepts/settings#param-theme) in docs.json using one of the following themes.</label>
<label className="text-lg prose prose-gray dark:prose-invert">Custom the appearance of your documentation<br /><br />Configure [theme](settings#param-theme) in docs.json using one of the following themes.</label>

<br />

Expand Down