obsidian-plugin/denmojo_obsidian-unread-dot
1
0
Fork 0
mirror of https://github.com/denmojo/obsidian-unread-dot.git synced 2026-07-22 06:49:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
5 commits 3 branches 6 tags 44 KiB
JavaScript 96.6%
CSS 3.4%
Find a file
Dennis M 65c86cc382
Roll up unread dots to ancestor folders (v1.1.0) 
Port the folder dot rollup from the abandoned 1.2.x beta line, without the
orange modified-file indicator. Folders inherit the blue dot when any
descendant file is unread, and a folder right-click 'Mark all in folder as
read' recursively clears descendants and reports the count. Bump to 1.1.0.
2026-06-25 06:12:07 -07:00
.gitignore Add plugin source and supporting files for v1.0.0 2026-05-03 09:35:45 -07:00
LICENSE Initial commit 2026-05-03 09:21:09 -07:00
main.js Roll up unread dots to ancestor folders (v1.1.0) 2026-06-25 06:12:07 -07:00
manifest.json Roll up unread dots to ancestor folders (v1.1.0) 2026-06-25 06:12:07 -07:00
README.md Roll up unread dots to ancestor folders (v1.1.0) 2026-06-25 06:12:07 -07:00
styles.css Roll up unread dots to ancestor folders (v1.1.0) 2026-06-25 06:12:07 -07:00
versions.json Roll up unread dots to ancestor folders (v1.1.0) 2026-06-25 06:12:07 -07:00

README.md

Unread Dot

A small Obsidian plugin that marks newly created files with a blue dot in the file explorer and clears the dot the moment you open the file. Helps you spot notes you have not yet read without having to maintain any frontmatter or tags.

Features

  • New files (any extension) get a blue dot in the file explorer the moment they are created.
  • The dot disappears the first time you click the file in the explorer or open it in a tab.
  • State persists across restarts in .obsidian/plugins/unread-dot/data.json.
  • Renaming or moving a file preserves its unread state.
  • File-explorer only. Wikilinks, graph view, and the editor are untouched.
  • Optional ignore lists by extension or path prefix (e.g., skip attachments).
  • Right-click any file for "Mark as read" / "Mark as unread".
  • Right-click any folder for "Mark all in folder as read" (recursive).
  • Folders inherit a dot when any descendant file is unread, so you can collapse a subtree and still see that something underneath is unread.
  • Commands: "Mark all notes as read", "Mark current note as unread".

First-run behavior

Existing files in the vault when you install the plugin are treated as already read. Only files created from that point forward get tracked. This avoids flooding the explorer with dots on day one.

Installation

From Community Plugins

  1. Settings → Community plugins → Browse
  2. Search for "Unread Dot"
  3. Install and enable

Manual install

  1. Download main.js, manifest.json, and styles.css from the latest release.
  2. Create a folder .obsidian/plugins/unread-dot/ inside your vault.
  3. Drop the three files into that folder.
  4. Restart Obsidian and enable the plugin in Settings → Community plugins.

Via BRAT (pre-release testing)

  1. Install the BRAT plugin.
  2. Add the beta plugin: denmojo/obsidian-unread-dot.
  3. Enable it in Settings → Community plugins.

Settings

  • Ignored extensions - comma-separated list of extensions (no leading dot) to skip. Example: png, jpg, pdf, opus.
  • Ignored path prefixes - one path per line. Files whose path starts with any of these will not be marked. Example: Attachments/ or Archive/.
  • Mark all read button - clears every unread mark in the vault.

Changes to ignore rules apply immediately and prune any currently marked files that match.

Commands

Command Description
Unread Dot: Mark all notes as read Clears every unread mark.
Unread Dot: Mark current note as unread Adds the active note back to the unread set.

Right-click menu

Right-click any file in the explorer to toggle its unread state. Files matching an ignore rule do not show the menu item. Right-click any folder for "Mark all in folder as read", which recursively clears every descendant file and reports how many notes it cleared.

Known limitations

  • Tracked state lives in the vault's .obsidian/ folder, so it syncs across devices only if you sync .obsidian/ (e.g., Obsidian Sync, Syncthing).
  • The plugin uses Obsidian's internal view.fileItems to attach the marker. This is widely used by community plugins but is not part of the public API and may need adjustment if Obsidian changes the file-explorer internals.

License

MIT - see LICENSE.