diff --git a/README.md b/README.md index b875625..13c5804 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,9 @@ It works on both Markdown and non-Markdown files, integrates into multiple UI su - [Feature Guide](docs/features.md): what the plugin can do across commands, UI surfaces, and workflows. - [Settings Reference](docs/settings.md): every option, grouped like the in-app settings. +![[Pasted image 20251124181735.png]] +![[Pasted image 20251124175911.png]] + ## Quick start 1. Open Settings → Note Status. @@ -45,11 +48,30 @@ It works on both Markdown and non-Markdown files, integrates into multiple UI su ## Screenshots -- Status assignment workflow: ![Status assignment workflow demonstration](images/status-assignment-demo.png) -- File explorer with status icons and hover overview: ![File explorer with status icons](images/file-explorer-status-icons.png) -- Status dashboard: ![Status dashboard with vault statistics](images/status-dashboard-overview1.png) ![Status dashboard with vault statistics](images/status-dashboard-overview2.png) ![Status dashboard with vault statistics](images/status-dashboard-overview3.png) -- Grouped status view: ![Grouped status view with filtering](images/grouped-status-filtering.png) -- Custom statuses editor: ![Custom statuses](images/custom-status-change.png) +- Nav bar with current status + + - ![[Pasted image 20251124175219.png]] + - ![[Pasted image 20251124175531.png]] + +- Status assignment: + + - ![[Pasted image 20251124175250.png]] + +- File explorer with status icons and hover overview: + - ![[Pasted image 20251124175828.png]] +- Multiple settings: + - ![[Pasted image 20251124181317.png]] +- Custom templates editor: + - ![[Pasted image 20251124180312.png]] + - ![[Pasted image 20251124180453.png]] +- Frontmatter tags mapping + - ![[Pasted image 20251124180719.png]] +- Grouped status view: + - ![[Pasted image 20251124181043.png]] +- Status dashboard: + - ![[Pasted image 20251124181152.png]] + - ![[Pasted image 20251124181213.png]] + - ![[Pasted image 20251124181233.png]] ## Installation @@ -87,7 +109,7 @@ It works on both Markdown and non-Markdown files, integrates into multiple UI su ## Data format -Statuses in YAML: +Statuses in YAML(as string or array, it depends of your settings): ```yaml --- @@ -99,11 +121,6 @@ obsidian-note-status: Works with Dataview, Templater, QuickAdd, and search. Non-Markdown uses the JSON store noted above. -## API / contributing / support - -- Issues & feature requests: [GitHub Issues](https://github.com/devonthesofa/obsidian-note-status/issues) / [Discussions](https://github.com/devonthesofa/obsidian-note-status/discussions). -- Contributions welcome: fork, follow dev setup in the wiki, open a PR. - ## Support the project [![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/aleixsoler) diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index cc1f91c..0000000 --- a/docs/README.md +++ /dev/null @@ -1,128 +0,0 @@ -# Note Status for Obsidian - -[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/aleixsoler) -[![GitHub release](https://img.shields.io/github/v/release/devonthesofa/obsidian-note-status)](https://github.com/devonthesofa/obsidian-note-status/releases) -[![Build Status](https://img.shields.io/github/actions/workflow/status/devonthesofa/obsidian-note-status/release.yml)](https://github.com/devonthesofa/obsidian-note-status/actions) -[![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22note-status%22%5D.downloads&url=https%3A%2F%2Fraw.githubusercontent.com%2Fobsidianmd%2Fobsidian-releases%2Fmaster%2Fcommunity-plugin-stats.json)](https://obsidian.md/plugins?id=note-status) -[![GitHub License](https://img.shields.io/github/license/devonthesofa/obsidian-note-status)](https://github.com/devonthesofa/obsidian-note-status/blob/master/LICENSE) -[![GitHub Stars](https://img.shields.io/github/stars/devonthesofa/obsidian-note-status)](https://github.com/devonthesofa/obsidian-note-status/stargazers) - -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. - -## Contents - -- [Feature Guide](docs/features.md): what the plugin can do across commands, UI surfaces, and workflows. -- [Settings Reference](docs/settings.md): every option, grouped like the in-app settings. - -![[Pasted image 20251124181735.png]] -![[Pasted image 20251124175911.png]] - -## 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 - - - ![[Pasted image 20251124175219.png]] - - ![[Pasted image 20251124175531.png]] - -- Status assignment: - - - ![[Pasted image 20251124175250.png]] - -- File explorer with status icons and hover overview: - - ![[Pasted image 20251124175828.png]] -- Multiple settings: - - ![[Pasted image 20251124181317.png]] -- Custom templates editor: - - ![[Pasted image 20251124180312.png]] - - ![[Pasted image 20251124180453.png]] -- Frontmatter tags mapping - - ![[Pasted image 20251124180719.png]] -- Grouped status view: - - ![[Pasted image 20251124181043.png]] -- Status dashboard: - - ![[Pasted image 20251124181152.png]] - - ![[Pasted image 20251124181213.png]] - - ![[Pasted image 20251124181233.png]] - -## Installation - -### Community Plugin Store (recommended) - -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](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. - -## 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): - -```yaml ---- -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://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/aleixsoler) - -**PayPal**: https://paypal.me/aleixsoler - ---- - -**License**: MIT · **Author**: [Aleix Soler](https://aleixsoler.com)