Skip to content

Markdown Tags VitePress plugin VS Code Obsidian ​

Reading Time

Reading time for this document is 1 minute for 208 words.

Inline syntax like ((tag|Done|green)) turns into a styled badge. Code blocks and inline code are left exactly as written, so you can document the syntax itself. The same syntax works in three places, each with its own package and its own page:

WherePackageDocs
VitePress 2 sitesvitepress-markdown-tagsVitePress
Visual Studio Code Markdown previewvscode-markdown-tagsVS Code
Obsidian reading view and live previewobsidian-markdown-tagsObsidian

Syntax ​

txt
((tag|label))
((tag|label|background))
((tag|label|background|foreground))
((<tag|label|background|foreground))     arrow style

Use | or / as the separator (((tag/Done/green))), but not both in one tag. Background is a preset color name or a hex code; foreground is a hex code. A label can't contain the separator.

See it live ​

Preset labels pick their own color:

  • todo planned grey
  • doing in-progress orange
  • done tip green
  • on-hold tbd proposed draft wip blue
  • mvp purple
  • warn yellow
  • blocked canceled error red

Or choose the colors yourself: Custom Hex color and the arrow style v2.

Tags work in tables too:

FeatureStatus
Inline badges((tag
Arrow tags((tag
Per-folder tagged pages((tag

Code released under the MIT License. BinaryNoir name and logos are trademarks of BinaryNoir. Legal · Terms · Privacy