HiDeoo / starlight-openapi

Starlight plugin to generate documentation from OpenAPI/Swagger specifications
https://starlight-openapi.vercel.app
MIT License
112 stars 14 forks source link

Feature Request: Support CommonMark markdown formatting for description fields #33

Closed Indyandie closed 5 months ago

Indyandie commented 5 months ago

Is your feature request related to a problem?

Rich Text Formatting

Throughout the specification description fields are noted as supporting CommonMark markdown formatting. Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by CommonMark 0.27. Tooling MAY choose to ignore some CommonMark features to address security concerns

Describe the solution you'd like

Render basic markdown for the description field

Describe alternatives you've considered

No response

Additional Context

Starlight OpenAPI Example - using pokeapi - openapi.yml

image

Stoplight Example - using the elements web component

image