Docs Ahoy documentation

Blocks

On this page
  1. Hints
  2. Steppers
  3. Expandable sections
  4. Figures
  5. Page cards
  6. File downloads
  7. A block we don't know

Beyond plain Markdown, pages can hold a few blocks. A block starts with three colons and a name on its own line, and ends with three colons:

Markdown
:::info
This is a hint.
:::

The / menu in the editor inserts each of them. Ten kinds of content are supported in total: hints, steppers, images, expandable sections, tables, figures, highlights, code blocks, page cards and file downloads. Embeds, tabs and card grids are not.

Hints

Four tones: info, warning, success and danger. A title in square brackets is optional.

Markdown
:::warning[Back up first]
Hints can hold any Markdown: **bold**, lists, code.
:::

Steppers

Numbered steps, each with a title. The outer fence has four colons, so the inner ones can close each step:

Markdown
::::stepper
:::step[Create the library]
Choose a name and a slug.
:::
:::step[Publish it]
Library menu, Publish.
:::
::::

Expandable sections

Content that opens on a click. The title is what readers see closed.

Markdown
:::expandable[What does it cost?]
The answer, in Markdown.
:::

Figures

An image with a caption under it: the first image inside the block, then the caption.

Markdown
:::figure
![The settings screen](asset:…)

Library settings, with Visibility open.
:::

Page cards

A card that leads to another page of the library, with that page's title:

Markdown
:::page-ref
[Getting started](page:…)
:::

File downloads

A download card with the file's name, type and size:

Markdown
:::file
[Price list](asset:…)
:::

Images, asset: and page: references are explained on Images and files and Links between pages.

A block we don't know

A name that isn't one of these, for example :::tabs, shows its content in a neutral box labelled as an unsupported block. Nothing is lost.