Skip to content

Markdown Template Standards

This document defines standard conventions for Markdown templates.

Headings

  • Use # for top-level headings.
  • Use ## for second-level headings and so on.
  • Keep heading text concise and descriptive.

Paragraphs

  • Separate paragraphs with a blank line.
  • Avoid long lines by wrapping text at around 80 characters.

Lists

  • Use - or * for unordered lists.
  • Use numbers with periods for ordered lists.
  • Indent nested list items by two spaces.

Code Blocks

  • Use fenced code blocks with language identifiers:

```python
print('Hello world')
```

Tables

  • Use a header row and separator row.
  • Align columns with spaces for readability.

Example:

Column Description
Name The item name
Value The item value
  • Use relative links for internal documentation.
  • Use full URLs for external references.

Emphasis

  • Use **bold** for strong emphasis.
  • Use *italic* for emphasis.
  • Use backticks for inline code.