mirror of
https://github.com/trevware/obsidian-sidebar-highlights.git
synced 2026-07-22 12:50:27 +00:00
No description
| .github/workflows | ||
| src | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .npmrc | ||
| esbuild.config.mjs | ||
| LICENSE | ||
| main.ts | ||
| manifest.json | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| styles.css | ||
| tsconfig.json | ||
| version-bump.mjs | ||
| versions.json | ||
Highlights Sidebar
A sidebar plugin for Obsidian that helps you view and manage text highlights, comments, and collections across your vault.
Features
- Create highlights from selected text using
==highlighted text==syntax - Sidebar view showing all highlights from the current file
- Search and filter highlights by text content
- Color coding with 5 different highlight colors
- Comments system using footnotes (e.g.,
==text==[^comment]) - Collections to organize highlights across multiple files
- Tag support for categorizing highlights
- Dynamic commands for viewing highlights in specific collections
Usage
Creating Highlights
- Select text in any markdown file
- Right-click and choose "Create highlight" from the context menu
- Or use the command palette:
Ctrl/Cmd + P→ "Toggle highlight" - Or manually type:
==your highlighted text==
Using the Sidebar
- Click the highlighter icon in the ribbon to open the sidebar
- The sidebar shows all highlights from the currently active file
- Click any highlight to jump directly to its location in the document
- Use the All Notes tab to view highlights from across your entire vault
- Group highlights by Color, Comments, Folder, Parent, Collection or Filename using the grouping buttons
- Filter by tags using the tag filter dropdown to show only highlights with specific tags
Adding Comments
Add footnotes immediately after highlights to create comments:
==Important text==[^1]
[^1]: This is my comment about the highlighted text
You can also click the comment button on any highlight in the sidebar and select "Add Comment" to create footnotes automatically at the highlight's location.
Working with Collections
- Switch to the Collections tab in the sidebar
- Click "New Collection" to create a collection
- Add highlights to collections using the collection button on each highlight
- View collection contents by clicking on any collection card
- Jump to collections by using the command palette
Color Coding
- Change highlight colors using the color picker in each highlight card
- 5 colors available: Gold, Red, Teal, Blue, and Green
- Colors help categorize and organize your highlights
Installation
- Download the plugin files
- Place them in your
.obsidian/plugins/obsidian-highlights-sidebar/folder - Enable the plugin in Obsidian's Community Plugins settings
Commands
- Toggle: Open/close the sidebar
- Go to "Collection": Jumps to that specific collection
Important Notes
- Manual removal: For now, highlights and comments must be manually removed from your markdown files by deleting the
==syntax and footnotes. - Collection commands: If a collection is deleted, the command to jump to that specific collection will remain in the command palette until reload. However, it will show (deleted) next to the name of a collection prior to reloading.
Support
For issues or feature requests, please visit the plugin's repository.
If you find this plugin helpful, consider buying me a coffee ☕