obsidian-plugin/devonthesofa_obsidian-note-status

mirror of https://github.com/devonthesofa/obsidian-note-status.git synced 2026-07-22 05:45:04 +00:00

Aleix Soler b90f414a85 chore: added images

2025-11-24 18:29:41 +01:00

5.4 KiB

Raw Blame History

Note Status for Obsidian

Track the lifecycle of every file with statuses you control. Works on Markdown and non-Markdown, shows badges in the status bar and explorer, and adds commands, dashboards, and quick actions to keep notes moving.

Feature Guide: what the plugin can do across commands, UI surfaces, and workflows.
Settings Reference: every option, grouped like the in-app settings.

! !

Quick start

Open Settings → Note Status.
Expand Templates & Statuses and keep a built-in template or add your own/custom-only set.
Pick where to see/change status: Status Bar or Editor Toolbar.
Set a status from the badge or run Change current note status.
Watch file explorer icons update; hover for the overview popup or click to change again.
If enabled, open the Status Dashboard or Grouped Status View from the ribbon/commands.

Key features

Status picker everywhere: status bar badge, editor toolbar, explorer context menus, commands.
Multi-status or single-status workflows; quick-status commands for hotkeys.
File explorer icons with configurable placement, frames, and visual treatments (row tint, underline, dot, border).
Status bar badges with accent/filled/dot styles and icon/text options; template names can auto-show on conflicts.
Dashboards and grouped views (gated by experimental toggles and vault size limit) for vault-wide visibility and quick actions.
Built-in templates (Colorful, Minimal, Academic, Project) plus full custom templates and standalone custom statuses.
Works with YAML frontmatter and non-Markdown via a synced JSON store; frontmatter mappings let you write to multiple keys.

Data model

Markdown: statuses live under the tag prefix (default obsidian-note-status). Map templates/statuses to extra YAML keys and optionally also write to the default.
Non-Markdown: stored in .obsidian/plugins/obsidian-note-status/non-markdown-statuses.json, kept in sync on rename/delete.
Single vs multi: multiple statuses by default; single-status mode can store as list (status: [draft]) or string (status: draft) for compatibility.

Screenshots

Nav bar with current status
- !
- !
Status assignment:
- !
File explorer with status icons and hover overview:
- !
Multiple settings:
- !
Custom templates editor:
- !
- !
Frontmatter tags mapping
- !
Grouped status view:
- !
Status dashboard:
- !
- !
- !

Installation

Community Plugin Store (recommended)

Obsidian → Settings → Community plugins.
Disable Safe mode → Browse → search “Note Status”.
Install and enable.

Manual

Download the latest release from GitHub Releases.
Extract main.js, manifest.json, and styles.css to .obsidian/plugins/note-status/.
Enable in Community plugins settings.

Example workflows

Personal knowledge

💡 idea → 📝 draft → ✏️ editing → ✅ completed → 📦 archived

Project delivery

📋 backlog → 🚦 ready → 👨‍💻 inDevelopment → 🧪 testing → 🚀 live

Academic

🔍 research → 📑 outline → ✏️ draft → 🔬 review → 📚 final

Data format

Statuses in YAML(as string or array, it depends of your settings):

---
obsidian-note-status:
    - active
    - inProgress
---

Works with Dataview, Templater, QuickAdd, and search. Non-Markdown uses the JSON store noted above.

Support the project

PayPal: https://paypal.me/aleixsoler

License: MIT · Author: Aleix Soler

5.4 KiB Raw Blame History