/

Box

The .box docs ↗ function creates a special box container with an inline title and block content.

Example 1

.box {Box title}
    Welcome to the **Quarkdown wiki**!
    Here you'll learn how to get started with your first document.

Box title

Welcome to the Quarkdown wiki! Here you’ll learn how to get started with your first document.

You can omit the title:

Example 2

.box
    Welcome to the **Quarkdown wiki**!
    Here you'll learn how to get started with your first document.

Welcome to the Quarkdown wiki! Here you’ll learn how to get started with your first document.

Box types

A box can have a type, which defaults to callout if not specified. The available types are:

Example 3

.box {Box title} type:{tip}
    This is a tip box!

.box {Box title} type:{note}
    This is a note box!

.box {Box title} type:{warning}
    This is a warning box!

Box title

This is a tip box!

Box title

This is a note box!

Box title

This is a warning box!

Automatic localization

If you omit the title, set .doclang, and the locale is supported, the box title is automatically localized.

Example 4

.box type:{tip}
    This is a tip box!

.box type:{note}
    This is a note box!

.box type:{warning}
    This is a warning box!

Tip

This is a tip box!

Note

This is a note box!

Warning

This is a warning box!

Boxes and typed quotes are two different ways to create typed alerts.