**bold**
_italic_
̀ inline code ̀
inline code
~~strikethrough~~
Footnote[^1]
> quotes
quotes
# A first-level title
## A second-level title
### A third-level title
info
, warn
, success
or error
) with the quote markdown syntax (lines starting with >
) if the first line contains one of the call-out types.$ref: "./path/to/local-markdown.md"
. In the same way you can extract part of your contract (usually JSON schema of your models into dedicated *.yaml
or *.json
files), you can extract your markdown content into dedicated files too.api-contract.yml
can thus looks like:docs/introduction.md
, docs/getting-started.md
, docs/use-cases.md
and docs/use-cases-examples.md
right next to your contract document, you will be able to generate a comprehensive API documentation with nicely formatted content for your users.x-topics
top-level property in your contract as explained in the dedicated help page.x-topics
property at the root of your documentation specification will let you add some content sections at the beginning of your documentation.