Link Search Menu Expand Document

Callouts in lakeFS Documentation

These are part of the just-the-docs theme, and use the Block Inline Attribute List (IAL) feature of Kramdown.

Syntax

Whilst the lakeFS docs typically use this syntax with the code after the block:

This is a note
{: .note }

This is a note

The just-the-docs documentation puts the code before the block, which makes more sense to the human eye when reading the Markdown too.

{: .note }
This is a note

This is a note

However, they render the same, as can be see above.

Configuration

Callouts are configured in the _config.yml file, with an identifier (such as note), a colour, and optionally a title.

callouts:
  note:
    color: blue
  warning:
    title: ⚠️ Warning ⚠️
    color: red
  tip:
    color: green
  fubar:
    color: purple

Here’s what the above callouts look like; notice that only warning includes a title:

{: .note }
This is a note

This is a note

{: .warning }
This is a warning

This is a warning

{: .fubar }
This is illustrating that the callout names are completely discretionary and not tied to their meaning

This is illustrating that the callout names are completely discretionary and not tied to their meaning

Custom titles

You can specify custom titles per block by appending -title to the block name and putting the custom title in the first line of the quoted block:

{: .tip-title }
> lakeFS Cloud
>
> For a fully-managed lakeFS solution check out https://lakefs.cloud/ today

lakeFS Cloud

For a fully-managed lakeFS solution check out https://lakefs.cloud/ today

You can also remove the title of a callout that includes one by default (such as warning) above:

{: .warning-title }
> Don't press the red button

Don’t press the red button

Or change the default title:

{: .warning-title }
> Here Be Dragons 🐲
>
> ALLES TURISTEN UND NONTEKNISCHEN LOOKENSPEEPERS! <br/>
> DAS KOMPUTERMASCHINE IST NICHT FÜR DER GEFINGERPOKEN UND MITTENGRABEN! ODERWISE IST EASY TO SCHNAPPEN DER SPRINGENWERK, BLOWENFUSEN UND POPPENCORKEN MIT SPITZENSPARKEN.

Here Be Dragons 🐲

ALLES TURISTEN UND NONTEKNISCHEN LOOKENSPEEPERS!
DAS KOMPUTERMASCHINE IST NICHT FÜR DER GEFINGERPOKEN UND MITTENGRABEN! ODERWISE IST EASY TO SCHNAPPEN DER SPRINGENWERK, BLOWENFUSEN UND POPPENCORKEN MIT SPITZENSPARKEN.

Multi-line Blocks

Callouts support multiple lines and/or paragraphs of content:

{: .note }
> A multi-paragraph block
>
> with <br/>
> linebreaks

A multi-paragraph block

with
linebreaks

Reference