Add visual flair to your Markdown documents with custom tag styles! Markdown Tags lets you highlight and style labels within Markdown using simple syntax, customizable colors, and optional arrow indicators—all in the native Visual Studio Code preview.
Features
🖌️ Customizable Colors
Use predefined colors or specify custom hex codes for both background and foreground colors, enabling unlimited styling options.
📄 Flexible Syntax
Simple, flexible syntax options:
((tag|label))
((tag|label|background-color))
((tag|label|background-color|foreground-color))
((<tag|label)) <!-- Adds an arrow to the left -->
🌈 Supports a Variety of Colors
Choose from predefined colors (grey
, green
, orange
, etc.) or use custom hex codes to suit your design preferences.
Getting Started
Install the Extension:
Add Tags in your Markdown files using the syntax below.
Open Preview (Right-click the Markdown file → "Open Preview" or Ctrl+Shift+V
on Windows or Cmd+Shift+V
on macOS) to view styled tags in action.
Basic Syntax Examples
((tag|todo)) ((tag|in-progress|#ffcc00)) ((tag|done|#28a745|#ffffff))
((<tag|planned)) ((<tag|custom test))
Customizing Colors
((tag|background|#ff4500)) ((tag|foreground||#ff6347)) ((tag|both colors|#32cd32|#ffffff))
Available supported tags: todo, planned, in-progress, doing, done, tip,
on-hold, tbd, proposed, draft, wip, mvp,
blocked, canceled, error, warning, warn
For each tag, the following colors are available: grey, green, yellow, orange, blue, purple, red.
See Examples Markdown Documents
Tag Examples
TODO
((tag|todo|grey))
((tag|todo|green))
((tag|todo|yellow))
((tag|todo|orange))
((tag|todo|blue))
((tag|todo|purple))
((tag|todo|red))
PLANNED
((tag|planned|grey))
((tag|planned|green))
((tag|planned|yellow))
((tag|planned|orange))
((tag|planned|blue))
((tag|planned|purple))
((tag|planned|red))
IN-PROGRESS
((tag|in-progress|grey))
((tag|in-progress|green))
((tag|in-progress|yellow))
((tag|in-progress|orange))
((tag|in-progress|blue))
((tag|in-progress|purple))
((tag|in-progress|red))
DOING
((tag|doing|grey))
((tag|doing|green))
((tag|doing|yellow))
((tag|doing|orange))
((tag|doing|blue))
((tag|doing|purple))
((tag|doing|red))
DONE
((tag|done|grey))
((tag|done|green))
((tag|done|yellow))
((tag|done|orange))
((tag|done|blue))
((tag|done|purple))
((tag|done|red))
TIP
((tag|tip|grey))
((tag|tip|green))
((tag|tip|yellow))
((tag|tip|orange))
((tag|tip|blue))
((tag|tip|purple))
((tag|tip|red))
... (repeat as necessary for remaining tags: on-hold, tbd, proposed, draft, mvp, etc.)
With Arrow (using ((<tag|label|bgcolor))
)
MVP
((<tag|mvp|grey))
((<tag|mvp|green))
((<tag|mvp|yellow))
((<tag|mvp|orange))
((<tag|mvp|blue))
((<tag|mvp|purple))
((<tag|mvp|red))
... (repeat as necessary for remaining tags: on-hold, tbd, proposed, draft, mvp, etc.)
Advanced Options
CSS Integration
Add custom styles by modifying the style.css
file in the extension folder to match your preferences.
Error Handling
The extension defaults to grey
when invalid colors are detected to ensure a consistent and polished look.
Contributing
Feel free to submit issues, feature requests, or contribute code on GitHub.
License
MIT License
Support
If you encounter any issues or have questions, please open an issue on GitHub.
Author
John Smith III
Acknowledgments
Thanks to all contributors and users for their support and feedback.