Skip to content

Commit fbcac1e

Browse files
docs: clarify renderer choices (#22)
1 parent 946e3cd commit fbcac1e

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -243,12 +243,16 @@ are read directly from your VSCode settings.
243243
The Preview panel renders the current OpenAPI document and lets you interact with it.
244244
Preview panel can be opened by opening the Command Palette (CTRL+Shift+P) and running the `OpenAPI Toolkit: Show API Document preview` command.
245245

246-
Supported renderers:
246+
The extension supports multiple OpenAPI preview renderers. You can switch between them by setting `speclynx.openapi.preview.renderer` in your VS Code settings:
247247

248-
- [Scalar API Reference](https://github.com/scalar/scalar/tree/main/packages/api-reference#readme) (default)
249-
- [SwaggerUI](https://github.com/swagger-api/swagger-ui)
248+
| Renderer | Description | Default |
249+
|-------------|-------------|---------|
250+
| **scalar** | [Scalar API Reference](https://github.com/scalar/scalar/tree/main/packages/api-reference#readme) ||
251+
| **swagger-ui** | [Swagger UI](https://github.com/swagger-api/swagger-ui) | |
250252

251-
To switch between renderers, change the `speclynx.openapi.preview.renderer` setting in your VSCode configuration.
253+
> In VS Code, go to **File → Preferences → Settings**, then search for **@ext:SpecLynx.vscode-openapi-toolkit**.
254+
>
255+
> This will display all settings provided by the extension.
252256
253257
###### Scalar API Reference
254258
![Scalar API Reference Preview](https://github.com/user-attachments/assets/176f07bf-b54a-42d7-91c3-d3d745017e5e)

0 commit comments

Comments
 (0)