# Daily Overview

A right-side panel plugin that surfaces **today's tasks and live project progress** — read directly from your Markdown notes, with **no Dataview index wait**.

> Why another task board? Diary / note templates often embed a `dataviewjs` dashboard in the note body. Every time you open the note, you wait for Dataview to build its index, run a full scan, and render asynchronously. Daily Overview moves that logic into a native plugin view: it reads your Markdown with the Obsidian API, opens instantly, and stays in the right sidebar as a switchable tab.

---

## Features

- **Task board** (scans the *Diary folder*)
  - 🎯 **Due today** — incomplete tasks whose `due` is today. Checkable in place.
  - 🔴 **Overdue** — incomplete tasks whose `due` is before today. Checkable in place.
  - ✅ **Done today** — completed tasks whose `[done::]` date is today.
  - 📅 **Upcoming** — incomplete tasks within `0 < due − today ≤ N`, with a dropdown to switch the window (7 / 14 / 30 / 90 days).
- **Project board** (scans the *Project folder*) — groups tasks by project file, shows overdue / pending counts, collapsible; fully-completed projects are auto-hidden.
- **Milestones** — one or more `name + start date` badges on the header (red), e.g. a running streak. Day 1 counts on the start date.
- **Write-back** — checking a task edits the source line and appends `[done:: today]`; unchecking removes it. The panel refreshes automatically.
- **Click to jump** — click any task row to open its source note; the 📎 link jumps to the linked note.
- **Configurable** — diary folder, project folder, future window, milestones, panel title, skip-archived toggle — all in settings, no hard-coded paths.
- **Multi-resolution** — adapts from narrow sidebars to wide layouts; designed for desktop and mobile (HarmonyOS / Android) Obsidian.

---

## Install

### Option A — Manual

1. Download `manifest.json`, `main.js`, `styles.css` from the latest release.
2. Put them in `<vault>/.obsidian/plugins/today-board/`.
3. In Obsidian: **Settings → Community plugins → enable "Daily Overview"**.
4. Click the gauge icon in the left ribbon (or run the command **"Daily Overview: Open"**) — the panel appears in the right sidebar.

### Option B — Obsidian Community Store

Once accepted into the Obsidian community store, install it directly from **Settings → Community plugins → Browse → search "Daily Overview"**. The store fetches the files from the GitHub release.

> This plugin reads and writes your Markdown task lines directly (no external network, no database).

---

## Task syntax

Tasks use the Dataview inline `due` field and an auto-written `done` field — fully compatible with your existing notes:

```
- [ ] Write quarterly report [due:: 2026-09-15]
- [x] Finished the spec [done:: 2026-09-10]
- [ ] Follow up on [[Project A]] progress [due:: 2026-09-12]
```

- `due` uses `[due:: YYYY-MM-DD]` — exactly your current convention.
- Checking a task auto-writes `[done:: YYYY-MM-DD]` (today) so **Done today** can be counted precisely.
- Only tasks checked *from now on* record a `done` date; historically-checked tasks without `done` are not counted as "Done today".

---

## Settings

All settings live under **Settings → Daily Overview**. Each item shows a short Chinese note below its English label.

| Setting | Meaning |
|---|---|
| **Diary folder** | Folder scanned for the task board. Only tasks inside count as Due / Overdue / Done / Upcoming. |
| **Project folder** | Folder scanned for the project board. |
| **Default future window (days)** | Default range for Upcoming; can also be switched via the in-panel dropdown. |
| **Milestones (multiple)** | One or more `name + start date`; day 1 on the start date, shown as a red badge on the header. Add / delete freely. |
| **Skip archived / paused projects** | Hide project files whose path contains `Archive-` or `Paused-`. |
| **Panel title** | Text shown on the panel header. |

---

## Development / Build

This plugin is a single-file build with **no bundler** — `main.js` uses `require('obsidian')` directly.

```bash
# Syntax check
node --check main.js
```

To release, tag a GitHub release and attach `manifest.json`, `main.js`, `styles.css`; the Obsidian community store (and manual installers) pulls the plugin from that release.

---

## Publishing checklist

- [ ] `manifest.json` — `id`, `name`, `version`, `minAppVersion`, `description` (no "Obsidian" in the description), `author`, `authorUrl`, `isDesktopOnly`.
- [ ] `versions.json` — maps each plugin version to the minimum app version.
- [ ] `README.md` — English primary (this file) + Chinese supplementary below.
- [ ] `LICENSE` — MIT (update the copyright holder if needed).
- [x] Tag a GitHub release and attach `manifest.json`, `main.js`, `styles.css`.
- [x] `authorUrl` in `manifest.json` is already set to the real GitHub profile (`https://github.com/XiaoyiHR`).

---

## 中文说明

本插件把你日记模板里「今日看板」的逻辑搬出笔记正文，改为一个**右侧常驻的原生面板**：直接读 Markdown，不依赖 Dataview 索引，打开即秒开。

### 功能
- **任务跟进**（扫描「日记文件夹」）：🎯 今日到期、🔴 已逾期、✅ 今日已办、📅 未来 N 天（下拉切换 7/14/30/90 天）。
- **项目跟进**（扫描「项目文件夹」）：按项目文件分组，显示逾期 / 待处理数量，可折叠；全部完成的项目自动隐藏。
- **里程碑**：一个或多个「名称 + 起始日期」，开始当天算第 1 天，顶部以红色徽标展示。
- **写回**：勾选任务即改源文件行并追加 `[done:: 今天]`；取消则移除。面板自动刷新。
- **点击跳转**：点任务行跳到源笔记；📎 链接跳到关联笔记。
- **可配置**：日记/项目文件夹、未来窗口、里程碑、面板标题、跳过归档，均在设置项，无硬编码路径。
- **多分辨率**：从窄侧栏到宽布局自适应，桌面与移动端（鸿蒙/安卓）均可用。

### 安装
1. 把 `manifest.json`、`main.js`、`styles.css` 放进 `<仓库>/.obsidian/plugins/today-board/`。
2. Obsidian 设置 → 社区插件 → 启用「Daily Overview」。
3. 点左侧栏仪表盘图标（或命令「Daily Overview: Open」）打开右侧面板。

### 任务语法
沿用你现在的写法：`[due:: YYYY-MM-DD]` 表示到期；勾选后自动写回 `[done:: YYYY-MM-DD]` 用于统计「今日已办」。

### 设置项（英文标签 + 中文说明）
- **Diary folder**：任务跟进扫描的文件夹。
- **Project folder**：项目跟进扫描的文件夹。
- **Default future window (days)**：未来任务的默认统计周期。
- **Milestones (multiple)**：里程碑（名称 + 起始日期），可多个、可增删。
- **Skip archived / paused projects**：跳过含 `Archive-` / `Paused-` 前缀的项目。
- **Panel title**：面板顶部标题文案。

> 说明：本插件仅读取并写回你自己的 Markdown 任务行，不联网、不建数据库，多端同步与你的笔记一致。