Does SmartDocs support GFM in Swagger 2.0 annotations?

Google Cloud Apigee
1

I understand the Swagger 2.0 spec supports GFM (GitHub-Flavored Markdown) to add rich text to certain fields.

Does Apigee SmartDocs support GFM in Swagger 2.0 annotations? If not, is there any plan to add support?

1 Like
2

Markdown in OpenAPI Specifications (the new name of the Swagger specification) can be rendered client side. Here’s an example you can follow using the marked.js library: https://github.com/apigee/smartdocs-templates/blob/markdown/templates/method/default-standalone.hbr#L627

Handling extensions might be a bit trickier. What did you have in mind?

1 Like