feature request: universal callouts

[nekomeowww]

Goal

1. Translate markups of container to VitePress, maybe follow the color of Obsidian for maximum compatibilities
2. Options to adjust icons and colors
3. While VitePress gain syntax supports from Obsidian and GFM (GitHub Flavored Markdown), Obsidian should be able to display and render both GFM and VitePress's markups as well.

Plans

• vitepress-plugin-uncallouts
• obsidian-plugin-uncallouts

Required to be compatible with

GFM (GitHub Flavored Markdown)

In GitHub flavored markdown, they would be declared as following:

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.

You can read more here: [Markdown] An option to highlight a "Note" and "Warning" using blockquote (Beta) · community · Discussion #16925

Microsoft Documentation

Note

Information the user should notice even if skimming.

Tip

Optional information to help a user be more successful.

Important

Essential information required for user success.

Caution

Negative potential consequences of an action.

Warning

Dangerous certain consequences of an action.

You can read more here: Markdown reference for Microsoft Learn - Contributor guide | Microsoft Learn

Obsidian

While Obsidian uses a similar approach with additional types supported:

Note

Lorem ipsum dolor sit amet

[!danger]
Lorem ipsum dolor sit amet

[!success]
Lorem ipsum dolor sit amet

You can read more here: Callouts - Obsidian Help

VitePress

And then VitePress uses another approach completely different:

::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::

You can read more here: Markdown Extensions | VitePress

Other things to be considered

• What about the other note-taking apps? How do they treat those blocks?
  • Logseq
  • Anytype
  • Notion
  • AFFiNE
  • Typora