Skip to content

Markdown Reference

Status: Active

Overview

This page provides a quick reference for the Markdown syntax adopted throughout the Nivron documentation.

Examples follow the conventions used by the documentation portal and should be used when creating or updating documentation pages.

Headers

# H1 Header
## H2 Header
### H3 Header
#### H4 Header
##### H5 Header
###### H6 Header

Text Formatting

**bold text**
*italic text*
***bold and italic***
~~strikethrough~~
`inline code`

[Link text](https://example.com)
[Link with title](https://example.com "Hover title")
![Alt text](image.jpg)
![Image with title](image.jpg "Image title")

Prefer relative links when referencing other documentation pages.

Lists

Unordered:
- Item 1
- Item 2
  - Nested item

Ordered:
1. First item
2. Second item
3. Third item

Blockquotes

> This is a blockquote
> Multiple lines

>> Nested quote

Code Blocks

Always specify the language.

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

```yaml
services:
  api:
    image: nivron/control-plane
```

Tables

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1    | Data     | Data     |
| Row 2    | Data     | Data     |

Horizontal Rules

---
***
___

Task Lists

- [x] Completed task
- [ ] Pending task
- [ ] Future task

Escaping Characters

\* \_ \# \`

Line Breaks

End a line with two spaces
to create a line break.

Use a blank line to start a new paragraph.

Mermaid Diagrams

Use Mermaid for architecture, workflow and relationship diagrams.

```mermaid
flowchart LR
    Client --> API
    API --> Database
```