Skip to content

Markdown Guidelines

  • Use headings to create a clear outline.
  • Use code fences with explicit languages.
  • Use tables only when the data is truly tabular.
  • Use callouts for warnings and notes.
  • Keep lists shallow and readable.

Example callout

Keep examples close to the explanation they support.

Markdown-first documentation for teams that update docs often.