Markdown guidelines

Principles

  • Simplicity.
  • Clarity.
  • Raw Markdown should be easy to read on its own.
  • Minimum dependencies on other documents or images (if possible).
  • Standard VDEC file naming conventions: all lower case, dashes instead of spaces, no other punctuation, md as extension. e.g., this file is named: vdec-marketplace-style-guidelines.md

Do

  • use #,##, etc for headers.
  • use - for unordered lists.
  • use bold for emphasis.
  • use ** to emphasize text.
  • keep sentences short and focused on one idea.
  • so that you can use unordered lists instead of paragraphs.

Do not

  • use —- or ===== for headers.
  • use + or * for unordered lists.
  • use italics for emphasis (difficult to read)
  • use <> for visible links: https://vdec.ca
  • add unnecessary empty lines.
  • nest lists too deeply.

Resources

24/08/2018