# Taskdown

**Your notes are the task board.** Taskdown turns plain Markdown checkbox lines into a live task panel in Obsidian: due dates, recurrence and goals stay in the notes, while the sidebar gives you grouping, a dashboard, a calendar, a heatmap and progress trends.

By **Helfas**. MIT licensed. The technical plugin id is `sfc-todo` (that is the folder name Obsidian installs), so existing data keeps working.

## Highlights

- **Notes are the source of truth.** A task is a line in a note, in the familiar Tasks style:
  `- [ ] Pay the rent  2026-10-01  every month  3`
- **One pane for everything.** Overdue / today / future / later groups, manual ordering, drag to reorder, multi-select and batch edit.
- **Recurring tasks roll in place.** Complete a recurring task and the next occurrence is written on the spot.
- **Calendar views.** Month, week, day, quarter and year, with drag-to-reschedule.
- **Home dashboard.** Activity heatmap, manual check-ins, goal streaks and progress trends.
- **`tasks` query blocks.** Embed a task view in a note with the same filter/sort/group vocabulary.
- **Optional AI planning.** With the companion **AI Host** plugin, turn a sentence, a recording or selected notes into task drafts. Nothing is written without your confirmation.
- **Chinese UI** and full mobile support.

## Installation

### Community plugins
Once Taskdown is listed in the community directory: **Settings  Community plugins  Browse**, search for `Taskdown`, then **Install** and **Enable**.

### Manual installation
1. Download `main.js`, `manifest.json` and `styles.css` from the latest GitHub release.
2. Put them in `<vault>/.obsidian/plugins/sfc-todo/`.
3. Reload Obsidian, then enable **Taskdown** in **Settings  Community plugins**.

## Getting started

1. Write a task in any note:
   - `- [ ] Buy milk  2026-09-18`
   - `- [ ] Review notes  every week`
   - `- [ ] Read 30 pages  3`
2. Open the panel from the ribbon icon (check-square) or the command **"打开任务与计划"**.
3. Open **Settings  Taskdown** to set the inbox note, the heading new tasks are filed under, the first day of the week, excluded folders and the default due date.

## AI planning (optional)

Taskdown itself has **no network code**. AI planning requires the companion **AI Host** plugin; provider keys stay in AI Host, and every proposed task is shown for review before anything is written. Without AI Host, everything except AI planning works normally.

## Privacy

Taskdown reads notes in your vault and stores its own state under `.obsidian/plugins/sfc-todo/`. It collects no telemetry and makes no network requests of its own.

## Development

```bash
npm ci
npm run build      # writes main.js
npm run verify     # bundle invariants
npm run typecheck
```

## License

MIT  2026 Helfas. See `LICENSE`. Third-party notices are in `THIRD-PARTY-NOTICES.md`.

## Vault access

Taskdown builds an index of your notes to find task lines. It reads note content through Obsidian's APIs, writes only the task line that you edit (after confirmation where the action changes existing text), and keeps its own state in the plugin folder inside your configuration directory. On desktop it uses Node's `fs` module only for atomic writes inside that same plugin folder; it never reads or writes paths outside the vault. It has no telemetry and no clipboard access.