Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aoout/obsidian-highlighter
Manage Highlights.
https://github.com/aoout/obsidian-highlighter
obsidian obsidian-plugin
Last synced: about 2 months ago
JSON representation
Manage Highlights.
- Host: GitHub
- URL: https://github.com/aoout/obsidian-highlighter
- Owner: aoout
- License: mit
- Created: 2023-09-22T04:35:06.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-06T15:25:30.000Z (4 months ago)
- Last Synced: 2024-09-06T18:05:51.522Z (4 months ago)
- Topics: obsidian, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 3.87 MB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# đź“ťHighlighter
Manage, display the highlights, and comment them in a elegant way.
## ⚡Usage
> [!warning]
> It's still early days for this plugin, I suggest you just try using it with the [epub importer](https://github.com/aoout/obsidian-epub-importer) to highlight books and manage higlights.### đź“–With Epub Importer
> [!note]
> Please set the setting tags on `highlighter` and `epub importer` to be the same.When **oneNote** is off, the book chapter notes will be scattered in a folder. In this case, all these notes are called an **HighlightBox**.
So when your activeNote is one of the notes, you are in this HighlightBox, and you can search all the highlights of this book through the `Search highlights in current HighlightBox` command.
![alt text](assets/image.png)
Moreover, when you are in a HighlightBox, by running the `Update highlights file` command, you can generate a **highlights.md** file, located in the root directory of the HighlightBox.
If you want to comment a highlight, you can type an @ symbol and then write the comment on a new line. If your input conforms to the format, your comments will be retained when the `Update highlights file` command updates the highlights.md file.
![alt text](assets/image-1.png)
When a highlight has a corresponding comment, place the mouse on the highlight and press the `ctrl` key, a pop-up window will display the comment.
![alt text](assets/image-2.png)
## 🖼️GIFs
### Jump to highlight
![alt text](assets/Obsidian_L2n1q4dAVu.gif)
## ⚙️How it works &... Why?
Highlighter matches each highlight solely based on the string content. This can lead to issues when there are two identical highlights, resulting in unpredictable outcomes.
The reason Highlighter does this, instead of using block IDs like many other plugins to mark and track each highlight, is that it aims to adhere to the File Over App philosophy as an Obsidian plugin. It strives to provide powerful highlighting and management features without adding any extra content or data that would disrupt the native semantics of the files.
If one day this plugin stops being updated or you decide to stop using Obsidian, your markdown files will still retain everything, such as the native markdown highlighting syntax and a visually intuitive highlights file. Additionally, your markdown source files won’t be cluttered with strange block IDs or CSS pollution.