Skip to content

Commit de02346

Browse files
committed
upate steps
1 parent 79586d7 commit de02346

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

api-playground/mdx-setup.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: 'markdown'
66

77
You can manually define API endpoints in individual `MDX` files rather than using an OpenAPI specification. This method provides flexibility for custom content, but we recommend generating API documentation from an OpenAPI specification file for most API documentation projects as it's more maintainable and feature-rich. However, MDX can be useful for documenting small APIs, prototyping, or when you want to feature API endpoints alongside other content.
88

9-
To generate pages for API endpoints using `MDX`, configure your API settings in `docs.json`, create individual `MDX` files for each endpoint, and use components like <ParamFields /> to define parameters. From these definitions, Mintlify generates interactive API playgrounds, request examples, and response examples.
9+
To generate pages for API endpoints using `MDX`, configure your API settings in `docs.json`, create individual `MDX` files for each endpoint, and use components like `<ParamFields />` to define parameters. From these definitions, Mintlify generates interactive API playgrounds, request examples, and response examples.
1010

1111
<Steps>
1212
<Step title="Configure your API">
@@ -24,7 +24,7 @@ To generate pages for API endpoints using `MDX`, configure your API settings in
2424
}
2525
```
2626

27-
If you would not like to show an API playground, you don't need to include auth types. Hide the playground with the following field:
27+
If you want to hide the API playground, use the `display` field. You do not need to include an auth method if you hide the playground.
2828

2929
```json
3030
"api": {
@@ -34,12 +34,12 @@ To generate pages for API endpoints using `MDX`, configure your API settings in
3434
}
3535
```
3636

37-
Find a full list of API configurations [here](settings#param-api).
37+
Find a full list of API configurations in [Settings](/settings#api-configurations).
3838
</Step>
3939

4040
<Step title="Create your endpoint pages">
4141

42-
Each API endpoint page should have a corresponding MDX file. At the top of each file, define:
42+
Each API endpoint page should have a corresponding `MDX` file. At the top of each file, define `title` and `api`:
4343

4444
```md
4545
---
@@ -56,11 +56,11 @@ To generate pages for API endpoints using `MDX`, configure your API settings in
5656

5757
<Note>
5858

59-
If you have `server` configured in [docs.json](settings), you can use relative paths like `/v1/endpoint`.
59+
If you have a `server` field configured in `docs.json`, you can use relative paths like `/v1/endpoint`.
6060

6161
</Note>
6262

63-
You can also override the globally-defined display mode for the API playground per page by adding `playground` at the top of the MDX file:
63+
You can override the globally-defined display mode for the API playground per page by adding `playground` at the top of the `MDX` file:
6464

6565
```md
6666
---
@@ -72,6 +72,6 @@ To generate pages for API endpoints using `MDX`, configure your API settings in
7272
</Step>
7373

7474
<Step title="Add your endpoints to your docs">
75-
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs [here](navigation).
75+
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs in [Navigation](/navigation).
7676
</Step>
7777
</Steps>

0 commit comments

Comments
 (0)