GitHub Syntax

This document is for help on GitHub flavor markdown, on the wiki and for use in issues, comments and source documentation.

• Wiki names don't carry abbreviations. Iow. filename for Bats HOWTO, is Bats-Howto.

• Also Bats was capitalized as a name by the original developer, not an abbreviation.

Comments

[//]: # "Here are some comment styles for you, using the opaque part of a URI-ref"
[//]: # "to store comments as references with unused reference ID's."
[//]: # (Compatible with online GitHub at least)
[//]: # (test test test)

This text has the comment-lines like above after this paragraph.

No additional lines are added, since GitHub seems to be fine. And many parsers as well. Other characters for references or quotation may work, but not with very cross-platform results. The safest is to use '//' and see what quotes work, starting with " and don't add empty comments. Add lines then if needed.

See this stackoverflow and the babelmark markdown comparison for the above stanza.