# `Markdown`

Text written in Markdown, the plain-text format for bold, headings and lists.

Use it for content people write. `markup.to_html` turns it into [`Html`](/docs/types/type-html.md) to show. For structured documents, use [`RichText`](/docs/types/type-rich-text.md). For plain text, use `Text`.

## Shape

One value, held as text in one set form, with no parts: `Visit [our site](https://example.com/).
`.

## Example

```jadpo
Markdown("Fresh **soup** daily.")
```

`Markdown(raw)` checks the text, and text that isn't one breaks the `format` rule.

`text.parse(raw, as: Markdown)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`.

## Good to know

- `text.format` shows it as plain text, with the marks removed.
- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

A string, in a request, a response or `json.write`:

```json
"Fresh **soup** daily."
"# Soups\n\n- Leek\n- Tomato"
"Tom & Jerry"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`Markdown` is in the group Text formats, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `Fresh **soup** daily.`, `# Soups\n\n- Leek\n- Tomato` and `Tom & Jerry`.

### How it is stored

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

### How it is 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.

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>