chore: updated readme
182
README.md
|
|
@ -1,95 +1,181 @@
|
|||
# Note Status for Obsidian
|
||||
|
||||
[](https://github.com/devonthesofa/obsidian-note-status/releases) [](https://obsidian.md/plugins?id=note-status) [](https://github.com/devonthesofa/obsidian-note-status/blob/master/LICENSE)
|
||||
[](https://github.com/devonthesofa/obsidian-note-status/releases)
|
||||
[](https://github.com/devonthesofa/obsidian-note-status/actions)
|
||||
[](https://obsidian.md/plugins?id=note-status)
|
||||
[](https://github.com/devonthesofa/obsidian-note-status/blob/master/LICENSE)
|
||||
[](https://github.com/devonthesofa/obsidian-note-status/stargazers)
|
||||
|
||||
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.
|
||||
|
||||
## Features
|
||||

|
||||
_Alt: Demonstration of assigning status to a note using the toolbar dropdown_
|
||||
|
||||
- **📋 Status Assignment**: Mark notes with workflow statuses
|
||||
- **🎯 Multi-Status Support**: Assign multiple statuses per note
|
||||
- **📁 File Explorer Icons**: Visual indicators in the file tree with configurable positioning
|
||||
- **🧭 Status Bar Integration**: View current status at a glance with custom unknown status icons
|
||||
- **⬇️ Toolbar Dropdown**: Change statuses quickly from the editor
|
||||
- **📊 Status Pane**: Dedicated view organizing notes by status with command palette access
|
||||
- **⚡ Batch Operations**: Update multiple files simultaneously
|
||||
- **🎨 Custom Statuses**: Define and reorder your own statuses with arrow controls
|
||||
- **🧩 Template-Based Filtering**: Scope statuses by note templates for better organization
|
||||
- **🔧 Full Customization**: Control how and where statuses appear
|
||||
- **🚀 Performance**: Optimized for large vaults (40k+ notes tested)
|
||||

|
||||
## 🎯 Features
|
||||
|
||||
## Quick Start
|
||||
- **📋 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)
|
||||
|
||||
### Install
|
||||

|
||||
_Alt: File explorer showing multiple notes with different status icons positioned next to note names and the tooltip with status overview_
|
||||
|
||||
1. **Obsidian → Settings → Community plugins**
|
||||
2. **Search "Note Status" → Install → Enable**
|
||||

|
||||
_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_
|
||||
|
||||
### First Use
|
||||
## 💻 Technology Stack
|
||||
|
||||
1. Open any note
|
||||
2. Click the `❓` icon in toolbar
|
||||
3. Select a status (e.g., "active")
|
||||
4. Status appears in status bar and file explorer
|
||||
Built with modern web technologies for performance and reliability:
|
||||
|
||||
## Example Workflows
|
||||
- **TypeScript** - Type-safe development
|
||||
- **React** - Modern UI framework
|
||||
- **esbuild** - Fast bundling and development
|
||||
- **Obsidian API** - Deep vault integration
|
||||
|
||||
### Personal Knowledge Management
|
||||
## 📦 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](https://github.com/devonthesofa/obsidian-note-status/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
|
||||
**Project Management**
|
||||
|
||||
```
|
||||
📋 backlog → 🚦 ready → 👨💻 inDevelopment → 🧪 testing → 🚀 live
|
||||
```
|
||||
|
||||
### Academic Research
|
||||
**Academic Research**
|
||||
|
||||
```
|
||||
🔍 research → 📑 outline → ✏️ draft → 🔬 review → 📚 final
|
||||
```
|
||||
|
||||
## Documentation
|
||||

|
||||
_Alt: Grouped status view showing notes organized by status with template filtering and search functionality_
|
||||
|
||||
### For Users
|
||||
### Custom Statuses
|
||||
|
||||
- **[📚 Quick Start Guide](https://github.com/devonthesofa/obsidian-note-status/wiki/📚-Quick-Start-Guide)** - Get running in 5 minutes
|
||||
- **[📖 User Manual](https://github.com/devonthesofa/obsidian-note-status/wiki/📖-User-Manual)** - Complete feature documentation
|
||||
- **[⚙️ Configuration Guide](https://github.com/devonthesofa/obsidian-note-status/wiki/⚙%EF%B8%8F-Configuration-Guide)** - Settings and customization
|
||||
- **[🚀 Performance Tuning](https://github.com/devonthesofa/obsidian-note-status/wiki/🚀-Performance-Tuning)** - Optimize for large vaults
|
||||
Create your own workflow:
|
||||
|
||||
### For Developers
|
||||
1. **Settings** → Note Status → Custom Statuses
|
||||
2. **Add Status** → Configure name, icon, color, description
|
||||
3. **Reorder** using arrow controls
|
||||
4. **Use** in your notes
|
||||
|
||||
- **[🏗️ Architecture Overview](https://github.com/devonthesofa/obsidian-note-status/wiki/%F0%9F%8F%97%EF%B8%8F-Architecture-Overview)** - Plugin structure and design
|
||||
- **[🔧 Development Setup](https://github.com/devonthesofa/obsidian-note-status/wiki/%F0%9F%94%A7-Development-Setup)** - Contributing guide
|
||||
Example custom status:
|
||||
|
||||
### Reference
|
||||
```
|
||||
Name: urgent
|
||||
Icon: 🔥
|
||||
Color: #FF0000
|
||||
Description: Requires immediate attention
|
||||
```
|
||||
|
||||
- **[📝 Frontmatter Format](https://github.com/devonthesofa/obsidian-note-status/wiki/%F0%9F%93%9D-Frontmatter-Format)** - Technical specification
|
||||

|
||||
_Alt: Status selection modal showing custom and template statuses with icons, names, and selection interface_
|
||||
|
||||
## Data Format
|
||||
## 📋 Data Format
|
||||
|
||||
Statuses are stored in note frontmatter:
|
||||
Statuses are stored in YAML frontmatter:
|
||||
|
||||
```yaml
|
||||
---
|
||||
obsidian-note-status:
|
||||
- HelloWorld
|
||||
- draft
|
||||
- active
|
||||
- inProgress
|
||||
---
|
||||
# Your note content
|
||||
```
|
||||
|
||||
## Contributing
|
||||
Works with:
|
||||
|
||||
Contributions welcome! See [🔧-Development-Setup](https://github.com/devonthesofa/obsidian-note-status/wiki/🔧-Development-Setup) for details.
|
||||
- **Dataview queries**
|
||||
- **Templater scripts**
|
||||
- **QuickAdd macros**
|
||||
- **Global search**
|
||||
|
||||
## Support the Development
|
||||
## 🛠️ API Reference
|
||||
|
||||
If you find this plugin useful and would like to support its development, you can make a donation through my PayPal account. Any contribution is greatly appreciated and helps me continue improving the plugin!
|
||||
For developers building integrations or contributing:
|
||||
|
||||
PayPal: https://paypal.me/aleixsoler
|
||||
📚 **[Developer Documentation](https://github.com/devonthesofa/obsidian-note-status/wiki)**
|
||||
|
||||
Includes:
|
||||
|
||||
- Architecture overview
|
||||
- Development setup
|
||||
- API reference
|
||||
- Contributing guide
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
We welcome contributions!
|
||||
|
||||
1. **Check** [GitHub Issues](https://github.com/devonthesofa/obsidian-note-status/issues) for bugs/features
|
||||
2. **Fork** the repository
|
||||
3. **Follow** [Development Setup](https://github.com/devonthesofa/obsidian-note-status/wiki/🔧-Development-Setup)
|
||||
4. **Submit** pull request
|
||||
|
||||
## 🐛 Support
|
||||
|
||||
- **📖 Documentation**: [Complete Wiki](https://github.com/devonthesofa/obsidian-note-status/wiki)
|
||||
- **🐞 Bug Reports**: [GitHub Issues](https://github.com/devonthesofa/obsidian-note-status/issues)
|
||||
- **💡 Feature Requests**: [GitHub Discussions](https://github.com/devonthesofa/obsidian-note-status/discussions)
|
||||
|
||||
## ❤️ Support Development
|
||||
|
||||
If you find this plugin useful:
|
||||
|
||||
[](https://paypal.me/aleixsoler)
|
||||
|
||||
**PayPal**: https://paypal.me/aleixsoler
|
||||
|
||||
---
|
||||
|
||||
**License**: MIT | **Author**: [Aleix Soler](https://aleixsoler.com)
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 4.7 KiB |
BIN
images/change-multiple-statuses.png
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
images/custom-status-change.png
Normal file
|
After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 22 KiB |
BIN
images/file-explorer-item.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
BIN
images/file-explorer-status-icons.png
Normal file
|
After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 13 KiB |
BIN
images/grouped-status-filtering.png
Normal file
|
After Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 110 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 9.3 KiB |
BIN
images/no-status-toolbar.png
Normal file
|
After Width: | Height: | Size: 5.9 KiB |
BIN
images/open-view-buttons.png
Normal file
|
After Width: | Height: | Size: 5.1 KiB |
|
Before Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 15 KiB |
BIN
images/status-assignment-demo.png
Normal file
|
After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 6.9 KiB |
BIN
images/status-dashboard-overview1.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
images/status-dashboard-overview2.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
images/status-dashboard-overview3.png
Normal file
|
After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 805 B |
|
Before Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 71 KiB |