Markdown quick reference
Headings
# Heading 1Page title
## Heading 2Section
### Heading 3Sub-section
Text formatting
**bold**Bold
*italic*Italic
~~strikethrough~~Strikethrough
`inline code`Inline code
Links & images
[text](url)Link
Image
Lists
- itemBullet list
1. itemNumbered list
Code blocks
```python
def hello():
print("Hi!")
```
Tables
| Column A | Column B |
|----------|----------|
| value | value |
Callouts (admonitions)
!!! note "Optional title"
Indented body text here.
note / tip / warning / dangerTypes
Diagrams (Mermaid)
```mermaid
graph TD
A[Start] --> B{Decision}
B -->|Yes| C[Result]
B -->|No| D[Other]
```
graph TD / LRFlowchart
sequenceDiagramSequence diagram
erDiagramEntity-relationship
Other
> quoteBlockquote
---Horizontal rule
HTML quick reference
Page structure
<section>
<h2>Section title</h2>
<p>Paragraph text.</p>
</section>
Text
<strong>bold</strong>Bold
<em>italic</em>Italic
<code>inline</code>Code
<mark>highlight</mark>Highlight
Links & media
<a href="">text</a>Link
<img src="" alt="">Image
Lists
<ul>
<li>Item</li>
</ul>
Tables
<table>
<thead><tr><th>Col</th></tr></thead>
<tbody><tr><td>Val</td></tr></tbody>
</table>
Allowed: structural tags (section, article, div, p…), tables, lists, links, images.
Stripped: <script>, <style>, <iframe>, event attributes.
API reference guide
Endpoint (method badge)
A code span starting with a method name becomes a styled badge:
`GET /api/resource/{id}`
`POST /api/resource`
`PUT /api/resource/{id}`
`DELETE /api/resource/{id}`
Parameters table
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | int | Yes | Resource ID |
JSON code block
```json
{
"field": "value"
}
```
Response codes table
| Status | Description |
|--------|----------------------|
| 200 | OK |
| 400 | Bad request |
| 401 | Unauthorised |
| 404 | Not found |
cURL example
```bash
curl -X GET https://api.example.com/resource/1 \
-H "Authorization: Bearer TOKEN"
```
Method badges: GET (green), POST (blue), PUT (orange), PATCH (teal), DELETE (red).
All standard Markdown features also work in API Reference articles.
