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
30 changes: 22 additions & 8 deletions changelog/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,36 @@
---

<Update label="February 2025">
## .md support for LLMs
## New Configuration Schema `docs.json`

We've introduced a new `docs.json` schema as a replacement for `mint.json`, to support better multi-level versioning, easier visual comprehension, and more consistent terminology. For more information on what's changed, [check out our blog](https://mintlify.com/blog/refactoring-mint-json-into-docs-json).&#x20;

Check warning on line 10 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L10

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.

## docs.json replacing mint.json

Upgrades include better multi-level versioning, easier visual comprehension, and more consistent terminology.
Upgrade from `mint.json` to `docs.json` with the following steps:

[Update your Mintlify CLI](/navigation/config-upgrade#upgrading-from-mint-json-to-docs-json).
1. Make sure your CLI is the latest version

```
npm i mintlify@latest -g
```

2. In your docs repository, run

```
mintlify upgrade
```

3. Delete your old mint.json file and push your changes

## CI Checks

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

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.

## More Themes

New pre-built themes to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global).
Expand Down Expand Up @@ -83,7 +99,7 @@

We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/settings/gitlab) to get started.

## Web Editor

Check warning on line 102 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L102

Did you really mean 'LLMs'?

<Frame>
<img src="/images/changelog/webeditor.jpg" alt="Web Editor" />
Expand Down Expand Up @@ -159,7 +175,7 @@
<img src="/images/changelog/advanced-footer.gif" alt="Advanced Footer" />
</Frame>

You can now add more links to the standard footer. This upgrade

Check warning on line 178 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L178

Did you really mean 'signup'?
provides more consistency between landing pages and docs, or greater customization
if you want to spotlight specific pages like socials or status logs.

Expand All @@ -183,7 +199,7 @@

* Added ability to add new deployment through dashboard settings.

## Bug Fixes

Check warning on line 202 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L202

Did you really mean 'autogenerated'?

* Can now use leading slashes in navigation.

Expand Down Expand Up @@ -264,7 +280,7 @@
## More

* **Troubleshooting for API pages**: API pages could be complicated so we listed
common issues to help you sort them out quickly —

Check warning on line 283 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L283

Did you really mean 'proxied'?
[Read the docs](/api-playground/troubleshooting)
</Update>

Expand Down Expand Up @@ -300,7 +316,7 @@

* Fixed a bug for the Segment integration functionality.

* We now raise more granular error messages for GitHub permissions when

Check warning on line 319 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L319

Did you really mean 'chatbot'?
interacting with the editor.

* Fixed bugs where the navigation would not properly expand when a direct link
Expand All @@ -321,8 +337,6 @@

* [Read the blog announcement](https://mintlify.com/blog/widget)

* [Learn how to install the Widget](/advanced/rest-api/overview)

## Pro Plan

We also updated our pricing plans for better customizability and scale.
Expand All @@ -331,7 +345,7 @@

## API Playground Code Example Sync

When you browse API docs, the selected code example now syncs across your pages.

Check warning on line 348 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L348

Did you really mean 'searchbar'?

## Insights

Expand All @@ -343,7 +357,7 @@
<Update label="June 2024">
## Launch Week Highlights

* Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your `mint.json` file and it'll update your docs styling.

Check warning on line 360 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L360

Did you really mean 'Okta'?

* Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated searchbar UI.

Expand All @@ -368,7 +382,7 @@
## Custom mode

Add a configuration to the metadata to remove all elements except for the top bar.
Example use cases:

Check warning on line 385 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L385

Did you really mean 'dcallouts'?

* Create a custom global landing page setup with custom components

Expand All @@ -380,7 +394,7 @@
</Update>

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

Check warning on line 397 in changelog/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog/overview.mdx#L397

Did you really mean 'frontmatter'?

Call snippets of our pre-built components an dcallouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).
</Update>
Expand All @@ -407,4 +421,4 @@
* Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome.

* AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
</Update>
</Update>
6 changes: 4 additions & 2 deletions code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@ icon: 'code'

### Inline Code

To denote a `word` or `phrase` as code, enclose it in backticks (`).
To denote a `word` or `phrase` as code, enclose it in backticks (\`).

```
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```



### Code Block

Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language.
Expand All @@ -36,4 +38,4 @@ class HelloWorld {
```
````

Visit the [Code Block page](/content/components/code) for more detailed docs.
Visit the [Code Block page](/content/components/code) for more detailed docs.
28 changes: 14 additions & 14 deletions content/components/cards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ icon: "rectangle"
</Card>

<RequestExample>
```jsx Card Example
<Card title="Click on me" icon="link" href="/content/components/card-group">
This is how you use a card with an icon and a link. Clicking on this card
brings you to the Card Group page.
</Card>
```

```jsx Image Card Example
<Card title="Image Card" img="/images/card-with-image.png">
Here is an example of a card with an image
</Card>
```
</RequestExample>

```jsx Card Example
<Card title="Click on me" icon="link" href="/content/components/card-group">
This is how you use a card with an icon and a link. Clicking on this card
brings you to the Card Group page.
</Card>
```

```jsx Image Card Example
<Card title="Image Card" img="/images/card-with-image.png">
Here is an example of a card with an image
</Card>
```

</RequestExample>

### Horizontal Card

Expand Down Expand Up @@ -70,4 +70,4 @@ Add an `img` property to a card to display an image on the top of the card.

<ResponseField name="img" type="string">
The url or local path to an image to display on the top of the card
</ResponseField>
</ResponseField>
3 changes: 1 addition & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@
"navigation/pages",
"navigation/divisions",
"navigation/versions",
"navigation/localization",
"navigation/config-upgrade"
"navigation/localization"
]
},
"migration"
Expand Down
Loading
Loading