Formatting and callouts

Formatting and callouts

Text, lists, tables and highlight boxes (callouts).

Everything here is plain Markdown. In the Studio, the formatting bar and the / menu insert each thing without you memorizing the syntax. See Writing in the editor.

Text

Bold, italic, strikethrough, highlight and code. Footnotes too.1

Lists

  • Items with a hyphen
    • and sub-items
  1. Numbered steps
  2. In order
  • Task done
  • Task to do

Tables

SectionFolderProperty
DocsDocsblup: docs
RoadmapRoadmapblup: roadmap

Headings

Level 2 (##) and level 3 (###) headings show in On this page, next to the text, and get their own link.

Callouts

Note

Write > [!note] Title and the text on the following lines, starting with >.

Info

Without a title, the callout shows the name of its type.

Tip

Types: note, abstract, info, todo, tip, success, question, warning, failure, danger, bug, example and quote. Aliases (hint, important, faq, caution, error…) work too.

Success

Each type has its own color and icon.

Question

Handy for frequently asked questions.

Warning

For heads-ups.

Danger

For things that can’t be undone.

Folded callout

A - after the type keeps the callout folded; click to open it. A + keeps it open, but foldable.


  1. They go to the end of the page, with a link back. ↩︎