devonthesofa_obsidian-note-status/README.md

Note Status for Obsidian

Track the status of your notes with a powerful, customizable status management system. Mark notes as active, completed, on hold, or create your own custom workflows.

Alt: Demonstration of assigning status to a note using the toolbar dropdown

🎯 Features

• 📋 Status Assignment - Mark notes with workflow statuses (active, completed, on hold, etc.)
• 🎯 Multi-Status Support - Assign multiple statuses per note
• 📁 File Explorer Icons - Visual indicators next to filenames with configurable positioning
• 🧭 Status Bar Integration - View current status at bottom of editor
• ⬇️ Toolbar Dropdown - Change statuses quickly from editor toolbar
• 📊 Status Dashboard - Vault overview with statistics and quick actions
• 📈 Grouped View - Browse notes organized by status with search and filtering
• ⚡ Batch Operations - Update multiple files simultaneously
• 🎨 Custom Statuses - Create your own statuses with icons, colors, and descriptions
• 🏷️ Template Scoping - Organize statuses by note templates
• 🚀 Performance Optimized - Works with large vaults (40k+ notes tested)

Alt: File explorer showing multiple notes with different status icons positioned next to note names and the tooltip with status overview

Alt: Status dashboard showing current note information, vault statistics with total notes and coverage percentages

Alt: Status distribution chart showing different statuses with colored bars and note counts for each status type

Alt: Quick actions panel with organized sections for views, current note operations, clipboard actions, and tools

💻 Technology Stack

Built with modern web technologies for performance and reliability:

• TypeScript - Type-safe development
• React - Modern UI framework
• esbuild - Fast bundling and development
• Obsidian API - Deep vault integration

📦 Installation

Community Plugin Store (Recommended)

1. Open Obsidian → Settings → Community plugins
2. Disable Safe mode → Browse → Search "Note Status"
3. Install and Enable

Manual Installation

1. Download 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

🚀 How to Use

Quick Start

1. Assign Status:

   1. Click the "No status" in toolbar

      

      Alt: Editor toolbar showing "No status" button for status assignment

   2. → Select a status

2. View in Explorer: Status icons appear next to note names

   

   Alt: Single file explorer item showing a note with status icon positioned next to the filename

3. Browse by Status or open the Dashboard: Open from left sidebar

   

   Alt: Left sidebar showing ribbon buttons for opening grouped status view and status dashboard

4. Batch Update: Select multiple files → Right-click → Change status

   

   Alt: Context menu appearing when right-clicking multiple selected files, showing "Change note status" option

Example Workflows

Personal Knowledge Management

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

Project Management

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

Academic Research

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

Alt: Grouped status view showing notes organized by status with template filtering and search functionality

Custom Statuses

Create your own workflow:

1. Settings → Note Status → Custom Statuses
2. Add Status → Configure name, icon, color, description
3. Reorder using arrow controls
4. Use in your notes

Example custom status:

Name: urgent
Icon: 🔥
Color: #FF0000
Description: Requires immediate attention

Alt: Status selection modal showing custom and template statuses with icons, names, and selection interface

📋 Data Format

Statuses are stored in YAML frontmatter:

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

Works with:

• Dataview queries
• Templater scripts
• QuickAdd macros
• Global search

Non-Markdown files (PDF, Canvas, images, etc.) can't host YAML frontmatter. Their statuses live in a lightweight JSON file under .obsidian/plugins/obsidian-note-status/non-markdown-statuses.json, and every command/view in the plugin reads from that store transparently. External tools such as Dataview or Templater still only see Markdown/frontmatter data, so keep using Markdown files if you need those integrations.

🛠️ API Reference

For developers building integrations or contributing:

📚 Developer Documentation

Includes:

• Architecture overview
• Development setup
• API reference
• Contributing guide

🤝 Contributing

We welcome contributions!

1. Check GitHub Issues for bugs/features
2. Fork the repository
3. Follow Development Setup
4. Submit pull request

🐛 Support

• 📖 Documentation: Complete Wiki
• 🐞 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Discussions

❤️ Support Development

If you find this plugin useful:

PayPal: https://paypal.me/aleixsoler

---

License: MIT | Author: Aleix Soler