cloud-annotations / docusaurus-openapi

🦕 OpenAPI plugin for generating API reference docs in Docusaurus v2.
https://docusaurus-openapi.netlify.app
MIT License
498 stars 82 forks source link

render examples in a `<code>` block #256

Closed chris48s closed 1 year ago

chris48s commented 1 year ago

The main thing here is to format the example value distinct from the other documentation text.

I think given these are values that would be passed in as a path or query param, using a <code> block is a reasonable, but open to other suggestions on it.

netlify[bot] commented 1 year ago

Deploy Preview for docusaurus-openapi ready!

Name Link
Latest commit 967e9086e38d4d3a11b118cc8ba2b88968a7ca16
Latest deploy log https://app.netlify.com/sites/docusaurus-openapi/deploys/64bd7165ec74800008cebda4
Deploy Preview https://deploy-preview-256--docusaurus-openapi.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.