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: api-playground/overview.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -133,7 +133,7 @@ This example configures the API playground to be interactive with example code s
133
133
134
134
### Custom endpoint pages
135
135
136
-
When you need more control over your API documentation, use the `x-mint` extension in your OpenAPI specification or create individual `MDX` pages for your endpoints.
136
+
When you need more control over your API documentation, use the `x-mint` extension in your OpenAPI specification or create individual MDX pages for your endpoints.
137
137
138
138
Both options allow you to:
139
139
@@ -143,7 +143,7 @@ Both options allow you to:
143
143
144
144
The `x-mint` extension is recommended so that all of your API documentation is automatically generated from your OpenAPI specification and maintained in one file.
145
145
146
-
Individual `MDX` pages are recommended for small APIs or when you want to experiment with changes on a per-page basis.
146
+
Individual MDX pages are recommended for small APIs or when you want to experiment with changes on a per-page basis.
Copy file name to clipboardExpand all lines: customize/react-components.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ import { ColorGenerator } from "/snippets/color-generator.jsx";
10
10
11
11
## Using React components
12
12
13
-
You can build React components directly in your `MDX` files using [React hooks](https://react.dev/reference/react/hooks).
13
+
You can build React components directly in your MDX files using [React hooks](https://react.dev/reference/react/hooks).
14
14
15
15
### Example
16
16
@@ -92,11 +92,11 @@ The counter renders as an interactive React component.
92
92
93
93
## Importing components
94
94
95
-
To import React components in your `MDX` files, the component files must be located in the `snippets` folder. You can then import them into any `MDX` page in your documentation. Learn more about [reusable snippets](/create/reusable-snippets).
95
+
To import React components in your MDX files, the component files must be located in the `snippets` folder. You can then import them into any MDX page in your documentation. Learn more about [reusable snippets](/create/reusable-snippets).
96
96
97
97
### Example
98
98
99
-
This example declares a `ColorGenerator` component that uses multiple React hooks and then uses it in an `MDX` file.
99
+
This example declares a `ColorGenerator` component that uses multiple React hooks and then uses it in an MDX file.
100
100
101
101
Create `color-generator.jsx` file in the `snippets` folder:
Copy file name to clipboardExpand all lines: editor.mdx
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,7 @@ Visual mode provides a WYSIWYG experience where changes that you make in the edi
88
88
89
89
### Markdown mode
90
90
91
-
Markdown mode provides direct access to the underlying `MDX` code of your documentation. This mode is ideal for when you need precise control over component properties or when you prefer to write in Markdown syntax.
91
+
Markdown mode provides direct access to the files that make up your documentation. This mode is ideal for when you need precise control over component properties or when you prefer to write in MDX syntax.
92
92
93
93
<Frame>
94
94
<img
@@ -224,9 +224,7 @@ In this example, you created a new page titled Themes and you want to add it to
224
224
225
225
Make changes to your pages using visual mode or Markdown mode in the editor.
226
226
227
-
In visual mode, press <kbd>/</kbd>
228
-
229
-
to open the component menu. Add content blocks, callouts, code blocks, and other components to customize your documentation.
227
+
In visual mode, press <kbd>/</kbd> to open the component menu. Add content blocks, callouts, code blocks, and other components to customize your documentation.
230
228
231
229
<Frame>
232
230
<img
@@ -242,13 +240,13 @@ In visual mode, press <kbd>/</kbd>
242
240
/>
243
241
</Frame>
244
242
245
-
In Markdown mode, you directly edit the `MDX` of your pages. This can be helpful when you need to:
243
+
In Markdown mode, you can directly edit the MDX of your pages. This can be helpful when you need to:
246
244
247
245
- Set specific component properties
248
246
- Work with complex nested components
249
-
- Copy and paste `MDX` content from other sources
247
+
- Copy and paste MDX content from other sources
250
248
251
-
See [Format text](/create/text) and [Format code](/create/code) for more information on how to write using Markdown syntax.
249
+
See [Format text](/create/text) and [Format code](/create/code) for more information on how to write using MDX syntax.
If you are currently using individual `MDX` pages for your API endpoints, you can migrate to autogenerating pages from your OpenAPI specification while retaining the customizability of individual pages. This can help you reduce the number of files you need to maintain and improve the consistency of your API documentation.
8
+
If you are currently using individual MDX pages for your API endpoints, you can migrate to autogenerating pages from your OpenAPI specification while retaining the customizability of individual pages. This can help you reduce the number of files you need to maintain and improve the consistency of your API documentation.
9
9
10
10
You can define metadata and content for each endpoint in your OpenAPI specification and organize endpoints where you want them in your navigation.
11
11
@@ -64,7 +64,7 @@ The migration tool does not support previewing changes before applying them.
64
64
</Step>
65
65
66
66
<Steptitle="Update your navigation structure.">
67
-
Replace `MDX` page references with OpenAPI endpoints in your `docs.json`.
67
+
Replace MDX page references with OpenAPI endpoints in your `docs.json`.
68
68
69
69
```json
70
70
"navigation": {
@@ -90,7 +90,7 @@ The migration tool does not support previewing changes before applying them.
90
90
</Step>
91
91
92
92
<Steptitle="Remove old MDX files.">
93
-
After verifying your new navigation works correctly, remove the `MDX` endpoint files that you no longer need.
93
+
After verifying your new navigation works correctly, remove the MDX endpoint files that you no longer need.
94
94
</Step>
95
95
</Steps>
96
96
@@ -138,9 +138,9 @@ Organize different API versions using tabs or groups:
138
138
}
139
139
```
140
140
141
-
## When to use individual `MDX` pages
141
+
## When to use individual MDX pages
142
142
143
-
Consider keeping individual `MDX` pages when you need:
143
+
Consider keeping individual MDX pages when you need:
144
144
145
145
- Extensive custom content per endpoint like React components or lengthy examples.
Copy file name to clipboardExpand all lines: installation.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -172,7 +172,7 @@ This command converts individual MDX endpoint pages to autogenerated pages defin
172
172
173
173
## Formatting
174
174
175
-
While developing locally, we recommend using extensions in your IDE to recognize and format `MDX` files.
175
+
While developing locally, we recommend using extensions in your IDE to recognize and format MDX files.
176
176
177
177
If you use Cursor, Windsurf, or VS Code, we recommend the [MDX VS Code extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
Copy file name to clipboardExpand all lines: migration.mdx
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -147,17 +147,21 @@ Migrate your documentation from any platform with full control over the process.
147
147
To migrate your content to Mintlify, you will need:
148
148
149
149
- A valid `docs.json` for your site settings and navigation. See [Global settings](/organize/settings) and [Navigation](/organize/navigation) for more information.
150
-
- An `MDX` file for each page of your documentation. See [Pages](/organize/pages) for more information.
150
+
- A Markdown file (`.md` or `.mdx`) for each page of your documentation. MDX is the recommended format. See [Pages](/organize/pages) for more information.
151
151
- (Optional) An OpenAPI specification for your API endpoint pages. See [OpenAPI setup](/api-playground/openapi-setup) for more information.
152
152
153
-
1. If your content is already in `MDX` format, copy the pages to your Mintlify project. Otherwise, convert your content to `MDX` format.
154
-
2. Create your `docs.json` referencing the paths to your `MDX` pages.
153
+
1. If your content is already in Markdown format, copy the content to your Mintlify project. Otherwise, convert your content to MDX format.
154
+
2. Create your `docs.json` referencing the paths to your Markdown pages.
155
155
3. If you have OpenAPI specifications, add them to your `docs.json` and configure the API playground.
156
156
157
+
<Tip>
158
+
If you migrate your content as `.md` files, convert them to `.mdx` to support interactive features like React components.
159
+
</Tip>
160
+
157
161
### Asset migration
158
162
159
163
1. Copy assets to your repository's `images/` directory.
0 commit comments