mdbin
Documentation menu

mdbin renders standard Markdown. This page is a quick reference for the everyday formatting — headings, emphasis, lists, tables, and the rest. Each example shows the Markdown you write, followed by how it renders.

Headings

Use # symbols — one per level, from # (largest) to ###### (smallest):

## Section
### Subsection

Headings automatically get a linkable anchor (hover one and click the #).

Emphasis

*italic* or _italic_
**bold** or __bold__
***bold italic***
~~strikethrough~~

Renders as: italic, bold, bold italic, strikethrough.

Lists

Unordered lists use - (or *); ordered lists use numbers. Indent to nest:

- First
- Second
  - Nested
- Third

1. One
2. Two
3. Three

Renders as:

  • First
  • Second
    • Nested
  • Third
  1. One
  2. Two
  3. Three

Task lists

Use - [ ] and - [x] for checkboxes:

- [x] Write the docs
- [ ] Ship it

Renders as:

  • Write the docs
  • Ship it

Tables

Pipe-separated columns, with a --- row under the header. Colons set alignment:

| Feature   | Supported |
| --------- | :-------: |
| Tables    | yes       |
| Footnotes | no        |

Renders as:

Feature Supported
Tables yes
Footnotes no

Blockquotes

Prefix lines with >:

> Quoted text.
> — Someone

Renders as:

Quoted text. — Someone

Alerts

Alerts (also called callouts) are blockquotes whose first line is a [!TYPE] marker. mdbin supports the five GitHub types — NOTE, TIP, IMPORTANT, WARNING, and CAUTION — each rendered with its own colour and icon:

> [!NOTE]
> Useful information that users should know.

> [!WARNING]
> Something that needs careful attention.

Renders as:

Note

Useful information that users should know.

Warning

Something that needs careful attention.

Add a title after the marker to replace the default label:

> [!TIP] Pro tip
> The callout heading can say whatever you like.

Renders as:

Pro tip

The callout heading can say whatever you like.

Any unrecognised type (for example > [!FOO]) is left as an ordinary blockquote.

Inline code

Wrap code in backticks: `like this`. For multi-line blocks and syntax highlighting, see Code blocks.

[A link](https://example.com)
![Alt text](/favicon.svg)

Bare URLs like https://forjed.io are auto-linked. External links open in a new tab and are hardened automatically (see Principles).

Horizontal rule

Three or more dashes on their own line:

---

Renders as a divider:

That's the everyday toolkit. For richer content, see Code blocks, Mermaid diagrams, and FreeDraw diagrams.