Skip to content

Markdown Cheatsheet

Quick reference for everything you need in MkDocs/Material. Author: Johan Beysen

1. Text Formatting

**bold**
*italic*
~~strikethrough~~
`inline code`
**_bold and italic_**

bold | italic | ~~strikethrough~~ | inline code

2. Headings

# H1 — Page title
## H2 — Main section
### H3 — Subsection
#### H4 — Sub-subsection

3. Lists

- unordered
- list
  - indented
  - sublevel

1. ordered
2. list
   1. indented

[link text](https://url.com)
[internal link](../tools/nmap.md)

![alt text](../assets/screenshot.png)
![alt text](../assets/screenshot.png){ width="600" }

5. Code

Inline: `code`

Block with syntax highlighting:

```bash
nmap -sV -sC -oA scan 10.10.10.1
```

```python
import requests
r = requests.get("https://target.com")
print(r.status_code)
```

```powershell
Get-ChildItem -Recurse | Select-Object Name
```

6. Tables

| Tool      | Use                  | Category   |
|-----------|----------------------|------------|
| Nmap      | Port scanning        | Recon      |
| Burp Suite| Web app testing      | Web        |
| Mimikatz  | Credential dumping   | Post-exploit|
Tool Use Category
Nmap Port scanning Recon
Burp Suite Web app testing Web
Mimikatz Credential dumping Post-exploit

7. Blockquotes

> This is a quote or a remark.
> Can span multiple lines.

This is a quote or a remark.

8. Horizontal Rule

---

9. Material Theme Extras

9.1 Admonitions (colored blocks)

!!! danger "Critical Finding"
    RCE possible via unsanitized input on the /upload endpoint.

!!! warning "Watch out"
    Only test on systems you have permission for.

!!! tip "Pro tip"
    Use Burp Repeater for manual testing of parameters.

!!! note "Note"
    See also the OWASP Testing Guide v4.

!!! success "Resolved"
    Patch rolled out on 2024-03-01.

!!! info "Info"
    CVE-2024-XXXX — CVSS score 9.8

Critical Finding

RCE possible via unsanitized input on the /upload endpoint.

Pro tip

Use Burp Repeater for manual testing of parameters.

9.2 Collapsible Blocks

```m u arkdown

Click to expand

Hidden content here. Handy for long payloads or output.

Open by default

This block is open by default.

??? note "Click to expand"
    Hidden content here. Handy for long payloads or output.

### 9.3 Tabs

```markdown
=== "Linux"
    ```bash
    curl -X POST https://target.com/api
    ```

=== "Windows"
    ```powershell
    Invoke-RestMethod -Uri https://target.com/api -Method POST
    ```

=== "Python"
    ```python
    requests.post("https://target.com/api")
    ```

9.4 Frontmatter

---
title: Page title
tags:
  - web-app
  - sqli
  - owasp
---

10. Handy Shortcuts in VS Code

Action Shortcut
Open preview Ctrl+Shift+V
Bold Ctrl+B
Italic Ctrl+I
Insert link Ctrl+K
Find in file Ctrl+F
Find in project Ctrl+Shift+F

11. MkDocs Specific

[See the nmap page](../tools/nmap.md)
[To a specific section](../tools/nmap.md#port-scanning)

Images in Assets

docs/
└── assets/
    └── screenshots/
        └── burp-scan.png

![Burp scan result](../assets/screenshots/burp-scan.png)

MkDocs Commands

mkdocs serve    # Start live preview
mkdocs build    # Build the static site
mkdocs new .    # Create a new project

More info: MkDocs Material documentation