Skip to content

Markdown Dictionary

A quick reference for writing content in this site.
Everything below is valid Markdown and compatible with MkDocs + Material.

Headings

Use # at the start of a line.

Markdown
# H1 – Page title
## H2 – Section
### H3 – Subsection
#### H4 – Smaller subsection

Paragraphs and Line Breaks

Separate paragraphs with a blank line.

Markdown
This is one paragraph.

This is another paragraph.

To force a line break, end the line with two spaces:

Markdown
First line␣␣
Second line

Emphasis

Markdown
*Italic text* or _italic text_

**Bold text** or __bold text__

***Bold and italic*** or ___bold and italic___

Lists

Unordered

Markdown
- Item one
- Item two
  - Nested item
- Item three

Ordered

Markdown
1. First
2. Second
3. Third

Task Lists

Markdown
- [ ] To do
- [x] Done
Markdown
[External link](https://example.com)

[Relative link](internal/runbooks.md)

[Link with hover](https://example.com "Hover text")

Images

Markdown
![Alt text](img/example.png)

Code

Inline

Markdown
Use `docker compose up -d`.

Code blocks

`markdownbash sudo systemctl restart docker ```

yaml services: traefik: image: traefik:v3

Blockquotes

```

This is a blockquote. It can span multiple lines.

  • Lists work inside quotes ```

Horizontal Rule

```

```

Tables

```markdown | Service | Description | Status | |------------|----------------------|--------| | Traefik | Reverse proxy | Up | | Authentik | Authentication | Up | | Splunk | Logging platform | Warn |

```

Alignment:

``` | Left | Center | Right | |:-----|:------:|------:| | a | b | c |

```

Admonitions

``` !!! note This is a note.

!!! warning This is a warning.

!!! info "Custom title" This box has a custom title.

```

Collapsible Sections

??? note "Click to expand" Hidden content goes here. You can include lists, code blocks, and more.

Footnotes

``` This sentence has a footnote.[^1]

[^1]: Footnote text.

```

Definition Lists

```
Term One
Definition for term one.
Term Two
First definition.
Second definition. ```

Cross-References

Link to another page

``` See Network Overview.

```

Link to a heading on the same page

See [Admonitions](#admonitions).

Link to a heading on another page

See [Runbooks – Recovery](internal/runbooks.md#recovery).

Images With Captions

```

Hedgenet Diagram

Figure 1: High-level Hedgenet layout. ```

Front Matter (Metadata)

```

title: Hedgenet Overview hide: - toc - navigation

```

General Writing Tips

markdown - Use one H1 per page. - Use H2/H3 for structure. - Prefer relative links. - Use admonitions for tips/warnings. - Store images under docs/img/ or docs/assets/. - Keep filenames lowercase-with-hyphens.