GitHub-Flavored Markdown

Last update: Download PDF Edit

Several places in published REST services indicate that you can use GitHub-flavored Markdown for rich text.

This is especially useful in case you want to include JSON example payload in your rest documentation. Just add three backticks, json, the JSON structure, and three backticks to close the code, as illustrated in this example:

For more information, see the GitHub Guide to Mastering Markdown.