Skip to content

πŸ“š The open-source, offline-first Notion, Obsidian & Confluence alternative. Advanced Markdown, multi-tenant teams, OIDC/SSO, and local S3 backups. Deploy in one command.

4.4 KB
Raw Blame

title: Containers and layout description: Organize information with callouts, panels, cards, and layout blocks. navigation: icon: i-lucide-panels-top-left

Containers add structure to a document without requiring custom HTML. Open a container with ::: and close it with ::: on its own line.

Coloured callouts

Use a colour name after the opening marker. The optional text after the colour becomes the title.

:::green Tip
Keep important context close to the content it explains.
:::

:::yellow Warning
Check your backups before an update.
:::

:::red Danger
Never publish passwords in a document.
:::

The available callout colours are green, grey, blue, yellow, red, and teal. When no title is provided, Alexandrie uses the default title for that colour: TIP, INFO, WARNING, or DANGER.

Details and visibility

Use details for content that should remain collapsed until the reader requests it.

:::details Further information
This content is collapsed by default.
:::

The title is clickable and the content can contain normal Markdown, including lists and code blocks.

The no-print container is visible on screen but excluded from PDF exports:

:::no-print
This is useful for screen-only instructions or navigation hints.
:::

Alignment and columns

Use center to center a block of content:

:::center
This text is centered.
:::

Use columns together with one or more column blocks for side-by-side content.

::::columns
:::column

### Left column

Content for the first column.
:::
:::column

### Right column

Content for the second column.
:::
::::

The outer container uses four colons because the inner containers use three. Close each block with the same number of colons used to open it.

Frames, cards, and panels

frame, card, and panel are general-purpose containers. They accept a block title and modifiers in the opening line.

:::frame border=red rounded title="Important"
This block has a red border and a title.
:::

:::card shadow bordered title="Decision"
Cards are useful for a self-contained piece of information.
:::

:::panel background=raised gap=md title="Remember"
Panels work well for supplementary information.
:::

Supported modifiers are:

Modifier Examples Effect
border border=red, border=teal Adds a colour-specific border class.
background background=base, background=raised, background=overlay Selects the panel background.
gap gap=sm, gap=md, gap=lg Selects internal spacing.
rounded rounded Adds a rounded appearance.
shadow shadow Adds a soft shadow.
bordered bordered Strengthens the border.
nowrap nowrap Prevents wrapping where the theme supports it.
wrap wrap Enables wrapping where the theme supports it.
title title="A title" Adds a header to the block.

Modifiers can be combined. Values are converted into CSS classes, so use the values supported by the active theme.

Information blocks

These blocks display a title with a semantic icon and colour. A title is required after the block name.

:::definition Definition
A term and its precise meaning.
:::

:::property Property
A notable property of the current object.
:::

:::theorem Theorem
A statement that can be proved or relied upon.
:::

:::warning Warning
A condition that requires attention.
:::

The specialised variants are info-red, info-blue, and info-teal:

:::info-blue Information
Additional context for the reader.
:::

Use these blocks for short explanations. For a simple coloured message without a semantic icon, use a coloured callout instead.