Skip to content

Commit 55f5ed2

Browse files
authored
Specify page-level playground settings (#889)
* Claude Code's commit * edit page-level playground info
1 parent b8d9699 commit 55f5ed2

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

api-playground/mdx/configuration.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To generate pages for API endpoints using `MDX`, configure your API settings in
5959

6060
</Note>
6161

62-
You can override the globally-defined display mode for the API playground per page by adding `playground` at the top of the `MDX` file:
62+
You can override the globally-defined display mode for the API playground for a page by adding `playground` to the frontmatter:
6363

6464
```mdx
6565
---
@@ -68,7 +68,11 @@ To generate pages for API endpoints using `MDX`, configure your API settings in
6868
playground: 'none'
6969
---
7070
```
71-
71+
72+
- `playground: 'interactive'` - Display the interactive playground.
73+
- `playground: 'simple'` - Display a copyable endpoint with no playground.
74+
- `playground: 'none'` - Hide the playground.
75+
7276
</Step>
7377

7478
<Step title="Add your endpoints to your docs">

api-playground/overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ When you need more control over your API documentation, create individual `MDX`
112112
- Add additional content like examples
113113
- Hide specific operations
114114
- Reorder pages in your navigation
115+
- Control playground behavior per page
115116

116117
See [MDX Setup](/api-playground/mdx/configuration) for more information on creating individual pages for your API endpoints.
117118

0 commit comments

Comments
 (0)