https://github.com/binarynoir/obsidian-markdown-tags
Enhance your Markdown documents with custom tags. Use predefined or custom labels, customizable colors, and arrow indicators to visually track tasks and statuses.
https://github.com/binarynoir/obsidian-markdown-tags
markdown obsidian obsidian-md obsidian-plugin obsidianmd
Last synced: 2 months ago
JSON representation
Enhance your Markdown documents with custom tags. Use predefined or custom labels, customizable colors, and arrow indicators to visually track tasks and statuses.
- Host: GitHub
- URL: https://github.com/binarynoir/obsidian-markdown-tags
- Owner: binarynoir
- License: mit
- Created: 2024-11-09T01:25:13.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-13T17:36:51.000Z (2 months ago)
- Last Synced: 2024-12-13T18:30:34.252Z (2 months ago)
- Topics: markdown, obsidian, obsidian-md, obsidian-plugin, obsidianmd
- Language: TypeScript
- Homepage: https://binarynoir.tech
- Size: 1.07 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Tags for Markdown: Enhanced Styled Labels for Obsidian
Add visual flair to your Markdown documents with custom tag styles! **Tags for Markdown** lets you highlight and style labels within Markdown documents using simple syntax, customizable colors, and optional arrow indicators—all within Obsidian. If you like **Tags for Markdown**, get our extension for [Visual Studio Code](https://github.com/binarynoir/vscode-markdown-tags/)!
[](https://buymeacoffee.com/binarynoir)
[](https://ko-fi.com/binarynoir)
[](https://binarynoir.tech)
## Features
### 🎨 Styled Tags
Highlight and style tags with ease using predefined or custom styles.
### 🖌️ 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:
```markdown
((tag|label))
((tag|label|background-color))
((tag|label|background-color|foreground-color))
((
```
### 🌈 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
1. **Install** the plugin from the Obsidian Community Plugins.
2. **Enable** the plugin in the Obsidian settings.
3. **Add Tags** in your Markdown files using the syntax below.
### Basic Syntax Examples
#### Status Tags
```markdown
((tag|todo)) ((tag|in-progress|#ffcc00)) ((tag|done|#28a745|#ffffff))
```
#### Arrowed Tags
```markdown
((/.obsidian/plugins/`
### Manually installing the plugin
Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/obsidian-markdown-tags/.
---
## Contributing
> Feel free to submit issues, feature requests, or contribute code on GitHub.
### Development
```bash
npm install
npm run build
cp main.js manifest.json /path/to/your/vault/.obsidian/plugins/obsidian-markdown-tags
```
### Release
### Releasing new releases
- Update the changelog with new features and fixes
- Commit all changed files and create a pull request
- Update the `manifest.json` with the new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
- Update the `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
- Create new GitHub release using the new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
- Publish the release.
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
```bash
git checkout main
git pull
git tag -a x.y.z -m "x.y.z"
git push --tags
```
The release will automatically be drafted.
## 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.