Skip to content

Commit 3799135

Browse files
mintlify[bot]tiffany-mintlifyhahnbeelee
authored
removed mint.json vs docs.json file (#527)
* Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Update overview.mdx changed numbering (buggy in web editor) * fix broken links * delete broken link * delete unneeded changes --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: tiffany-mintlify <[email protected]> Co-authored-by: Hahnbee Lee <[email protected]>
1 parent 48323e6 commit 3799135

File tree

7 files changed

+65
-330
lines changed

7 files changed

+65
-330
lines changed

changelog/overview.mdx

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,36 @@ mode: "center"
55
---
66

77
<Update label="February 2025">
8-
## .md support for LLMs
8+
## New Configuration Schema `docs.json`
9+
10+
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;
911

10-
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.
1112

12-
## docs.json replacing mint.json
1313

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

16-
[Update your Mintlify CLI](/navigation/config-upgrade#upgrading-from-mint-json-to-docs-json).
16+
1. Make sure your CLI is the latest version
17+
18+
```
19+
npm i mintlify@latest -g
20+
```
21+
22+
2. In your docs repository, run
23+
24+
```
25+
mintlify upgrade
26+
```
27+
28+
3. Delete your old mint.json file and push your changes
1729

1830
## CI Checks
1931

2032
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).
2133

34+
## .md support for LLMs
35+
36+
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.
37+
2238
## More Themes
2339

2440
New pre-built themes to modify the look & feel of your docs. Configure via your [docs.json file](/settings/global).
@@ -321,8 +337,6 @@ mode: "center"
321337

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

324-
* [Learn how to install the Widget](/advanced/rest-api/overview)
325-
326340
## Pro Plan
327341

328342
We also updated our pricing plans for better customizability and scale.
@@ -407,4 +421,4 @@ mode: "center"
407421
* 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.
408422

409423
* AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
410-
</Update>
424+
</Update>

code.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@ icon: 'code'
88

99
### Inline Code
1010

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

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

17+
18+
1719
### Code Block
1820

1921
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.
@@ -36,4 +38,4 @@ class HelloWorld {
3638
```
3739
````
3840

39-
Visit the [Code Block page](/content/components/code) for more detailed docs.
41+
Visit the [Code Block page](/content/components/code) for more detailed docs.

content/components/cards.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ icon: "rectangle"
1010
</Card>
1111

1212
<RequestExample>
13+
```jsx Card Example
14+
<Card title="Click on me" icon="link" href="/content/components/card-group">
15+
This is how you use a card with an icon and a link. Clicking on this card
16+
brings you to the Card Group page.
17+
</Card>
18+
```
19+
20+
```jsx Image Card Example
21+
<Card title="Image Card" img="/images/card-with-image.png">
22+
Here is an example of a card with an image
23+
</Card>
24+
```
25+
</RequestExample>
1326

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

21-
```jsx Image Card Example
22-
<Card title="Image Card" img="/images/card-with-image.png">
23-
Here is an example of a card with an image
24-
</Card>
25-
```
26-
27-
</RequestExample>
2828

2929
### Horizontal Card
3030

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

7171
<ResponseField name="img" type="string">
7272
The url or local path to an image to display on the top of the card
73-
</ResponseField>
73+
</ResponseField>

docs.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@
3333
"navigation/pages",
3434
"navigation/divisions",
3535
"navigation/versions",
36-
"navigation/localization",
37-
"navigation/config-upgrade"
36+
"navigation/localization"
3837
]
3938
},
4039
"migration"

0 commit comments

Comments
 (0)