Skip to content

Markdown Cheat Sheet

Quick reference for all markdown syntax and MkDocs-specific patterns used in EPMware documentation.

Text Formatting

Syntax Result Usage
**bold text** bold text UI elements, field names, buttons
*italic text* italic text Image captions, emphasis
`code text` code text Filenames, paths, code values
~~strikethrough~~ ~~strikethrough~~ Deprecated items

Headings

# Page Title          (one per page)
## Main Section
### Subsection
#### Sub-subsection

<!-- Same folder -->
[Page Title](filename.md)

<!-- Different folder — up one level -->
[Page Title](../other-section/filename.md)

<!-- With anchor to specific section -->
[Section Title](../section/filename.md#section-heading)

<!-- Same folder -->
<a href="filename/" class="md-button">Label →</a>

<!-- Up two levels (from nested pages like appendices/) -->
<a href="../../other-section/filename/" class="md-button">Label →</a>

[:material-arrow-right: Link Text](filename.md)

Images

![Alt text description](../assets/images/section/image-name.png)<br/>
*Caption in italics*

Admonitions

!!! note
    Note content indented with 4 spaces.

!!! warning
    Warning content indented with 4 spaces.

!!! tip
    Tip content indented with 4 spaces.

!!! important
    Important content indented with 4 spaces.

??? note "Collapsible Title"
    Hidden until clicked. Indented with 4 spaces.

Tables

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Numbered Procedures

1. First step with **bold UI elements**.

2. Second step with a sub-step:

    1. Sub-step one.
    2. Sub-step two.

3. Third step.

Leave blank lines between top-level steps for better spacing.

Code Blocks

```yaml
key: value
nested:
  item: data
```

```bash
mkdocs serve
mkdocs build
```

```python
print("Hello, World!")
```

Material Design Icons

:material-arrow-right:      →
:material-check-circle:     ✓
:material-alert:            ⚠
:material-information:      ℹ
:material-cog:              ⚙
:material-shield-account:   🛡
:material-file-document:    📄
:material-book-open:        📖
:material-rocket-launch:    🚀
:material-sitemap:          🗺
:material-open-in-new:      ⧉

Card Layout (HTML)

<div class="grid cards">
  <div class="card">
    <h3>⚙️ Card Title</h3>
    <p>Card description text</p>
    <a href="target-page.md" class="md-button">Action Label →</a>
  </div>
</div>

Horizontal Rule

---

Creates a horizontal divider line between sections.

Mermaid Diagrams

```mermaid
graph LR
    A[Start] --> B[Process]
    B --> C[End]
```

Key Reminders

  • One # heading per page — the page title
  • Blank lines between list items — for better spacing in procedures
  • 4-space indent for admonitions — not tabs
  • <br/> between image and caption — for proper positioning
  • :material-*: icons only — :octicons-*: is not supported
  • Include .md in markdown links — MkDocs rewrites them
  • Omit .md in HTML href links — use directory-style paths with trailing slash