You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/mintlify.mdx
+40-5Lines changed: 40 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,13 +35,17 @@ To integrate Mintlify with Speakeasy, you'll need the following:
35
35
36
36
<GetPublicUrlSnippet />
37
37
38
-
### Update the `mint.json`configuration file
38
+
### Update the configuration file
39
39
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.
41
41
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.
43
43
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
45
49
{
46
50
"anchors": [
47
51
{
@@ -55,7 +59,38 @@ Add the combined spec URL to **Anchors** by updating the `anchor` field in the `
55
59
}
56
60
```
57
61
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:
0 commit comments