README file from
GithubYori Dashboard
An Obsidian dashboard plugin that gathers your daily events, data logs, tasks, check-ins, moments, monthly plans, and quick links into one organized page you can view and edit at a glance.
Features
- Calendar + Daily Events — A month mini-calendar lets you switch the focused date; the events column on the right manages today's items, and the More button opens a weekly view that supports archiving.
- Data Log — Record daily metrics such as weight, words written, sleep, expenses, etc. Browse the monthly history and archive it as a note.
- Task Box — Organize tasks by category boxes. Add quickly from the dashboard, or open the full task view for everything.
- Check-in — Customizable colored buttons for habits; the monthly view shows your streak.
- Daily Moments — Capture timestamped notes throughout the day with 12/24-hour support.
- Monthly Planner — Outline this month's plans, browse the entire year in the yearly view, and archive.
- Quick Links — Hover the bottom blank area of either column to add a quick link with a custom name and color that jumps to a chosen note.
Installation
Community plugin
- Open Obsidian: Settings → Community plugins → Browse
- Search for Yori Dashboard
- Install and enable
Manual install
- Download
main.js,manifest.json, andstyles.cssfrom the latest GitHub release. - Place them inside your vault at
.obsidian/plugins/yori-dashboard/. - If the folder doesn't exist, create
yori-dashboardunderplugins. - Enable the plugin in Obsidian.
Note:
main.jsalready bundles every module fromlib/into a single file. For deployment only those three files are required — you don't need to copylib/,src/,tests/, orscripts/.
Usage
- Click any date in the mini-calendar to switch focus; use the chevrons to change month.
- Daily events support checkboxes, click-to-edit, and right-click for delete/copy/paste. The More button opens the weekly view.
- In Data Log, click a value to edit it (Enter to commit). The
...button opens the monthly history with archive support. - In Task Box, the right-top settings button manages categories; pick a category from the dropdown when adding a task on the dashboard.
- Check-in buttons toggle today's status with one click. Color comes from the activity setting.
- Daily Moments respects 12/24-hour format; existing entries follow the active format. Use the Daily Summary button to create or open a per-day summary note.
- Monthly Planner's yearly view lists all 12 months; archive a year as a single note.
- Hover the bottom blank area of a column to reveal
+ Quick linkand configure a button. Drag a quick button to reorder; right-click to delete.
Settings
- Interface language — Chinese / English (Chinese defaults to 24-hour, English defaults to 12-hour).
- Section length — Medium / Long; controls how many items each section displays on the dashboard.
- Time format — 12 or 24 hour (affects Daily Moments).
- Quick link open mode — Smart / always new tab / replace current tab.
- Archive folder — Where archive notes are saved (created if missing).
- Dashboard sections — Toggle individual sections on or off.
Compatibility
- Minimum Obsidian version: see
minAppVersioninmanifest.json. - Desktop only (mobile is not yet supported).
Development
- Source entry:
src/main.js. Business modules live inlib/; section renderers underlib/sections/. - Unit tests:
npm test(built on Node's built-innode:test). - Bundle:
npm run build— a zero-dependency bundling script that emits a singlemain.jsto the project root.
Feedback & Contributions
License
MIT — see LICENSE in the repository root.