Skip to content

Commit 90ebd75

Browse files
docs: Update mintlify guide to reflect mint.json to docs.json update (#52)
1 parent 62db272 commit 90ebd75

File tree

1 file changed

+40
-5
lines changed

1 file changed

+40
-5
lines changed

docs/integrations/mintlify.mdx

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,17 @@ To integrate Mintlify with Speakeasy, you'll need the following:
3535

3636
<GetPublicUrlSnippet />
3737

38-
### Update the `mint.json` configuration file
38+
### Update the configuration file
3939

40-
Add the combined spec URL to **Anchors** or **Tabs** in the `mint.json` file of a Mintlify repository. Anchors are displayed as a list of links on the left side of the documentation, while Tabs are displayed as tabs along the top of the documentation.
40+
Add the combined spec URL to **Anchors** or **Tabs** in the configuration file of a Mintlify repository.
4141

42-
Add the combined spec URL to **Anchors** by updating the `anchor` field in the `mint.json` file as follows:
42+
**Note:** Mintlify has transitioned from `mint.json` to `docs.json` as their primary configuration file. The configuration format remains the same, but the filename has changed.
4343

44-
```json mint.json
44+
#### Using docs.json (Recommended)
45+
46+
Add the combined spec URL to **Anchors** by updating the `anchor` field in the `docs.json` file as follows:
47+
48+
```json docs.json
4549
{
4650
"anchors": [
4751
{
@@ -55,7 +59,38 @@ Add the combined spec URL to **Anchors** by updating the `anchor` field in the `
5559
}
5660
```
5761

58-
Add the combined spec URL to **Tabs** by updating the `tab` field in the `mint.json` file as follows:
62+
Add the combined spec URL to **Tabs** by updating the `tab` field in the `docs.json` file as follows:
63+
64+
```json docs.json
65+
{
66+
"tabs": [
67+
{
68+
"name": "API Reference",
69+
"url": "api-reference",
70+
// !mark
71+
"openapi": "SPEAKEASY_COMBINED_SPEC_URL"
72+
}
73+
]
74+
}
75+
```
76+
77+
#### Using mint.json (Legacy)
78+
79+
If you're using the legacy `mint.json` configuration file, the format remains the same:
80+
81+
```json mint.json
82+
{
83+
"anchors": [
84+
{
85+
"name": "API Reference",
86+
// !mark
87+
"openapi": "SPEAKEASY_COMBINED_SPEC_URL",
88+
"url": "api-reference",
89+
"icon": "square-terminal"
90+
}
91+
]
92+
}
93+
```
5994

6095
```json mint.json
6196
{

0 commit comments

Comments
 (0)