Obsidian Study Dashboard

A single-page dashboard for an Obsidian vault. Built for tracking a long study plan — textbooks, kanban boards, a timetable and a study log — in one place.

Everything is driven by files already in your vault. There is no server, no account, and nothing leaves your machine.

What you get

Seven tabs

Tab	Shows
首页 Home	Next event, urgent tasks, assessments, progress rings, quick links
日程 Schedule	Today's agenda, next 14 days as collapsible per-day blocks, task deadlines
待办 To-Do	Every open task grouped by kanban column, with live checkboxes
进度 Progress	Per-project sections, curriculum view, gantt timeline, board archiving
学习 Study	Pomodoro timer, heatmap, 21-day chart, subject breakdown
笔记 Notes	Vault stats, folder breakdown, recently modified
复习 Review	Deadline countdowns, stale-note queue, thin notes

A flip clock — HH:MM over DD.MM, transparent, digits fold on change.

A curriculum view — each textbook is a collapsible row with a master progress bar; expanding shows one vertical bar per chapter, coloured by state, plus how far ahead or behind plan you are.

A Pomodoro timer that writes finished sessions straight into your study log, merging repeat sessions on the same topic the same day.

Sixteen appearance combinations — 4 palettes × 2 finishes × 2 colour modes, all switched from the header and remembered.

Axis	Options
Palette	木 Pampas (warm) · 霜 Frost (icy) · 主题 Theme (inherits your theme) · 自定 Custom (generated from one colour you pick)
Finish	清脆 Crisp (stark white) · 柔和 Muted (softer)
Tone	彩色 Semantic (red/amber/green) · 单色 Tonal (one hue, urgency reads as lightness)

No gradients anywhere — every fill is a flat colour, by design.

Requirements

Obsidian (desktop)
Dataview plugin, with Enable JavaScript Queries turned on — required
Kanban plugin — recommended, for editing boards
Optional: Minimal theme, which the included snippet is tuned for

Install

See docs/SETUP.md for the full walkthrough. Short version:

Copy vault-template/* into your vault, keeping the folder structure.
Copy obsidian-config/snippets/*.css into .obsidian/snippets/ and enable them in Settings → Appearance → CSS snippets.
Settings → Community plugins → enable Dataview, then Dataview settings → turn on Enable JavaScript Queries.
Open Dashboard.md.

Two things to edit for your own setup, both marked ⚠ CHANGE ME:

System/Dashboard/view.js → CFG.TZ — your timezone
System/Dashboard/view.js → CFG.PROJECTS — labels for your top-level folders

How it finds your data

Nothing is hardcoded to one vault. The dashboard discovers everything:

Source	Used for
Any note with `kanban-plugin` frontmatter	Tasks, progress, curriculum, archiving
Checklist items in ordinary notes	Task counts and deadlines
`System/Study Log.md`	Heatmap, streak, weekly hours
`System/Calendar.md`	Schedule tab, up-next countdown

Boards are grouped into projects by their outermost folder, so a board at Maths/Plan/board.md lands under a "Maths" project automatically.

A 📅 YYYY-MM-DD in a task is read as its due date — the Tasks plugin's format, though you don't need that plugin installed since Dataview parses it.

A note on the bilingual labels

Tab names and section headings render as 首页 Home, 日程 Schedule and so on. If you want English only, the labels live in the TABS array and in zh/en pairs throughout view.js — a find-and-replace, not a setting.

Privacy

This repo contains code only. The .gitignore excludes System/Calendar.md and System/Study Log.md, since those hold real schedules and study history. Your notes are never part of this repo.

If you fork it and push changes back, check git status before committing — that's the moment personal files sneak in.

Licence

MIT. Do what you like with it.

obsidian-dashboard