# `Markdown`

CommonMark text, with no control character but a tab, a line feed or a carriage return; `markup.to_html` renders it as `Html`.

[Text formats](types.md#text-formats); not ordered; since Jadpo 0.1.0.

## Make one

Build one from its text, `Markdown("Fresh **soup** daily.")`, which checks it: text that isn't one breaks `format`.

`text.parse(raw, as: Markdown)` reads one from its text; text that isn't one at all fails `malformed`, such as `"a\u0000b"` or `"ring the bell\u0007"`.

## Text, JSON and storage

`text.from` writes its canonical text, the one form `text.parse` reads back. JSON sends its canonical text as a string.

| Text | JSON |
|---|---|
| `Fresh **soup** daily.` | `"Fresh **soup** daily."` |
| `# Soups\n\n- Leek\n- Tomato` | `"# Soups\n\n- Leek\n- Tomato"` |
| `Tom & Jerry` | `"Tom & Jerry"` |
| `Visit [our site](https://example.com/).\r\n` | `"Visit [our site](https://example.com/).\r\n"` |

It is stored in one column named for the field, of type `text`. `Tom & Jerry` is stored as `'Tom & Jerry'`.

## Shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `Fresh **soup** daily.` | `Fresh soup daily.` |
| `"# Soups\n\n- Leek\n- Tomato"` | `"Soups\nLeek\nTomato"` |
| `Tom & Jerry` | `Tom & Jerry` |
| `"Visit [our site](https://example.com/).\r\n"` | `Visit our site.` |

## Operations

- `markup.to_html(markdown: Markdown) -> Html`: `markdown` rendered as CommonMark (0.31.2), then made safe as every `Html` is: raw HTML inside it is kept only where the sanitiser keeps it, and an image is shown as its description, since `Html` keeps no images.

Like every standard type, it also has the contract's own operations: `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. It isn't ordered, so `<` and sorting don't take it. [Every standard type meets one contract](../topics/every-standard-type-meets-one-contract.md) says how they work.