A lightweight plugin for Obsidian that allows you to easily mark and highlight text in your notes.
- Quick Formatting: Apply different text styles with simple commands
- Toggle Support: Turn formatting on/off with the same command
- Multiple Styles: Highlight, bold, italic, strikethrough, and code
- Flexible Selection: Works with both selected text and current line
- Default Style: Quick mark command using your preferred style
- Custom Tags: Create your own formatting with custom tags
- Categories: Organize your custom tags into categories
- User-Friendly: Simple settings interface for customization
- Smart Wrapping: Automatically handles nested and existing formatting
- Select text you want to format or place your cursor on a line
- Open the command palette (
Ctrl+PorCmd+P) - Choose one of the formatting commands:
| Command | Result | Example |
|---|---|---|
| "Highlight text" | ==text== |
==highlighted text== |
| "Bold text" | **text** |
bold text |
| "Italic text" | _text_ |
italic text |
| "Strikethrough text" | ~~text~~ |
|
| "Inline code" | `text` |
code text |
| "Quick mark with default style" | Uses your default setting |
- Toggle Formatting: Run the same command again to remove formatting
- Empty Lines: Places just the prefix when used on empty lines
- Multiple Selections: Works with Obsidian's multi-cursor feature
- Download the latest release
- Extract to your vault's plugins folder:
c:\Users\user\Documents\obsidian\My Coding Vault\.obsidian\plugins\obsidian-simple-marker\ - Reload Obsidian
- Enable the plugin in Community Plugins settings
Choose your preferred default style for the quick mark command:
- Highlight (
==text==) - Bold (
**text**) - Italic (
_text_) - Strikethrough (
~~text~~) - Code (
`text`)
Create your own formatting patterns:
- Format:
prefix|postfix(e.g.,<mark>|</mark>creates<mark>text</mark>) - Assign categories for better organization
- Invalid formats show visual warnings
- Node.js v16+
- pnpm
git clone https://github.com/maro14/obsidian-simple-marker.git
cd obsidian-simple-marker
pnpm installHere's an updated version of your README with a new "Troubleshooting & FAQ" section added at the end. This section addresses common issues and provides guidance for users.
// ... existing code ...
## 🛠️ Development
### Prerequisites
- Node.js v16+
- pnpm
### Setup
```bash
git clone https://github.com/maro14/obsidian-simple-marker.git
cd obsidian-simple-marker
pnpm install
- Make sure you have extracted the plugin to the correct folder:
c:\Users\user\Documents\obsidian\your Vault\.obsidian\plugins\obsidian-simple-marker\ - Reload Obsidian or restart the app after copying the files.
- Check that the plugin is enabled in the Community Plugins settings.
- Ensure you are using the latest version of Obsidian and the plugin.
- Check the console (Ctrl+Shift+I → Console tab) for error messages and report them on the GitHub Issues page.
- Try disabling other plugins to rule out conflicts.
- Make sure your custom tag format is
prefix|postfix(e.g.,<mark>|</mark>). - Both prefix and postfix must be non-empty.
- If you see a warning, double-check your input for typos or missing parts.
- The plugin looks for exact matches of the prefix and postfix. If your text contains similar patterns, toggling may not work as intended.
- Nested or overlapping formatting may cause unexpected results.
- Settings are stored in your vault's
.obsidian/plugins/obsidian-simple-marker/data.jsonfile. - If you accidentally delete or overwrite this file, your settings will be lost. Consider backing up your vault regularly.
- For help, feature requests, or bug reports, please visit the GitHub repository.