Skip to content

Use of Markdown

Chuck May edited this page Feb 26, 2016 · 5 revisions

There are certain text fields that were designed to use Markdown.

For Schemas:

  • description
  • notes

For Tables:

  • description
  • notes
  • footnotes

Markdown has many flavors which can cause subtle rendering differences. All the fields above were developed using CommonMark.

From the CommonMark site:

CommonMark is a standard, unambiguous syntax specification for Markdown, along with a suite of comprehensive tests to validate Markdown implementations against this specification.

CommonMark has a large list of validated implementations covering all common programming languages. If you use one of those implementations to render any of the fields above you can be assured it will render as intended.

Clone this wiki locally