No description
Find a file
2026-03-19 18:49:40 +01:00
.github/workflows feat: add release workflow 2025-04-03 16:08:37 +02:00
.husky feat: increase packages versions; add lintern; add formatter; add pre-commit hook 2025-05-25 12:08:27 +02:00
components feat(ui): allow custom editable template IDs during creation and unlockable inputs 2026-03-19 12:07:10 +01:00
constants fix(settings): restore predefined templates as default and auto-enable them 2026-03-19 11:52:30 +01:00
core fix(settings): restore predefined templates as default and auto-enable them 2026-03-19 11:52:30 +01:00
docs chore: add readme 2025-11-24 18:53:24 +01:00
images chore: added images 2025-11-24 18:29:41 +01:00
integrations feat: make status bar badges reactive and add content modes 2025-11-22 11:32:02 +01:00
scripts chore: cleanup unused code and enhance marketplace author links 2026-03-18 16:58:41 +01:00
styles Merge branch 'master' into feature/templates-marketplace 2026-03-18 19:42:54 +01:00
templates/predefined refactor(templates): separate predefined templates into subdirectory and update build script 2026-03-19 11:52:27 +01:00
types refactor(templates): separate predefined templates into subdirectory and update build script 2026-03-19 11:52:27 +01:00
utils refactor: replace separate author and github fields with authorGithub username 2026-03-18 18:10:00 +01:00
wiki chore: remove unused setting 2025-07-21 18:55:19 +02:00
.editorconfig Initial commit 2025-04-03 15:49:10 +02:00
.eslintignore Initial commit 2025-04-03 15:49:10 +02:00
.eslintrc Initial commit 2025-04-03 15:49:10 +02:00
.gitignore chore: remove .obsidian folder, added to gitignore 2025-07-21 20:54:30 +02:00
.npmrc Initial commit 2025-04-03 15:49:10 +02:00
esbuild.config.mjs refactor(templates): separate predefined templates into subdirectory and update build script 2026-03-19 11:52:27 +01:00
LICENSE chore: update the LICENSE file 2025-05-05 12:20:13 +02:00
main.tsx feat: add support for default status on new notes 2026-03-18 19:38:17 +01:00
manifest.json feat: v3.0.0 manifest 2025-11-24 19:16:38 +01:00
package-lock.json refactor: vanillajs to react 2025-07-15 17:30:17 +02:00
package.json chore: cleanup unused code and enhance marketplace author links 2026-03-18 16:58:41 +01:00
README.md refactor: replace separate author and github fields with authorGithub username 2026-03-18 18:10:00 +01:00
styles.css chore(build): update compiled css 2026-03-19 11:52:34 +01:00
tsconfig.json refactor: use templates/ folder as single source of truth and cleanup unused code 2026-03-18 17:25:48 +01:00
version-bump.mjs Initial commit 2025-04-03 15:49:10 +02:00
versions.json Initial commit 2025-04-03 15:49:10 +02:00

Note Status for Obsidian

PayPal Buy Me a Coffee

GitHub release Build Status Obsidian Downloads GitHub License GitHub Stars

Track the lifecycle of every file in your vault using statuses you fully control. Note Status brings visual clarity and structured workflows to Obsidian—whether you're managing research notes, writing projects, tasks, or long-term archives.

It works on both Markdown and non-Markdown files, integrates into multiple UI surfaces, and provides configurable dashboards, commands, and fast actions to keep information flowing.

Contents

Big picture 1 Big picture 1

Quick start

  1. Open Settings → Note Status.
  2. Expand Templates & Statuses and keep a built-in template or add your own/custom-only set.
  3. Pick where to see/change status: Status Bar or Editor Toolbar.
  4. Set a status from the badge or run Change current note status.
  5. Watch file explorer icons update; hover for the overview popup or click to change again.
  6. 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

    • navbar-unnasigned
    • navbar-multiple
  • Status assignment:

    • change-not-status-modal
  • File explorer with status icons and hover overview:

    • file-explorer-and-popup
  • Multiple settings:

    • settings-collapsed
  • Custom templates editor:

    • settings-collapsed
    • settings-collapsed
  • Frontmatter tags mapping

    • frontmatter-mappings
  • Grouped status view:

    • status-groups-full-picture-2
  • Status dashboard:

    • status-dashboard-1
    • status-dashboard-2
    • status-dashboard-3

Template Marketplace

You can contribute your own status templates to the plugin!

How to contribute (The Easy Way)

  1. Create a custom template in the plugin settings.
  2. Click the Share (📤) icon on your custom template.
  3. Follow the instructions in the modal to copy the JSON and submit a Pull Request to the official repository.
  4. Maintainers will review your submission and accept it if it passes the revision!

How to contribute (Manual)

  1. Fork the repository. ...
  2. Create a new JSON file in the templates/ folder (e.g., templates/my-awesome-workflow.json).
  3. Follow this format:
    {
      "id": "my-awesome-workflow",
      "name": "My Awesome Workflow",
      "description": "A workflow for doing awesome things",
      "authorGithub": "your-username",
      "statuses": [
        { "name": "todo", "icon": "📝", "color": "#ff0000", "templateId": "my-awesome-workflow" },
        { "name": "done", "icon": "✅", "color": "#00ff00", "templateId": "my-awesome-workflow" }
      ]
    }
    
  4. Submit a Pull Request with your JSON file!

Once accepted and merged, your template will be automatically included in the next build and available in the marketplace for all users.

Installation

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

Manual

  1. Download the latest release from GitHub Releases.
  2. Extract main.js, manifest.json, and styles.css to .obsidian/plugins/note-status/.
  3. 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 Buy Me a Coffee


License: MIT · Author: Aleix Soler