Skip to content

Markdown

Formatting diffs can be useful. Just set diff as the code block’s language.

for i in range(5):
print(i + 1)
print(i)
return 0

Source. Supported by GitHub (not by default AFAIK). Multiline footnotes are supported (see the gif here).

This is some text with a footnote[^1].
[^1]: This is the footnote text.

Source. Also known as an “aside”. Great for drawing attention to an important piece of information (warning, error, etc.). Supported by GitHub.

> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> Negative potential consequences of an action.

Docs. For support in Starlight Obsidian, use the syntax shown below. Note: using the syntax above seems to be buggy (e.g., try !WARNING, it is rendered as a !NOTE callout). For more examples see here.

:::caution
This is an important warning!
:::

Source. You can use HTML tags inside markdown. See for example the centering of the logo here (source).