# obstd

**Repository Path**: zhoutp/obstd

## Basic Information

- **Project Name**: obstd
- **Description**: Obsidian plugin for todo list preview
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-25
- **Last Updated**: 2026-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Obstd

一个 [Obsidian](https://obsidian.md) 插件，用于聚合展示 vault 中所有文档的待办事项。

## 为什么需要这个插件？

Obsidian 中的待办事项往往分散在不同的笔记文件中，时间久了很容易遗忘。Obstd 会自动扫描所有 Markdown 文件，将待办事项集中展示在右侧面板中，让你一目了然。

## 功能

- **聚合待办** - 自动扫描 vault 中所有 Markdown 文件的 `- [ ]` 和 `- [x]` 待办项
- **筛选模式** - 支持「所有 / 未完成 / 已完成」三种筛选
- **实时更新** - 文件修改后自动刷新待办列表
- **切换状态** - 点击 checkbox 直接在源文件中切换完成状态
- **跳转定位** - 点击文件名跳转到源文件对应行
- **统计信息** - 顶部显示待办总数、未完成数、已完成数

## 安装

### 手动安装

1. 从 [Releases](https://github.com/zhoutaoping/obstd/releases) 下载 `main.js`、`manifest.json`、`styles.css`
2. 在你的 vault 目录下创建 `.obsidian/plugins/obstd/` 文件夹
3. 将下载的三个文件放入该文件夹
4. 重启 Obsidian，在「设置 → 社区插件」中启用 Obstd

## 使用

- 点击左侧 Ribbon 栏的 ✅ 图标打开待办面板
- 或使用命令面板（`Ctrl/Cmd + P`）搜索「打开待办面板」

## 开发

```bash
# 安装依赖
npm install

# 开发模式（文件监听，自动重新编译）
npm run dev

# 生产构建
npm run build
```

## 许可证

[MIT](LICENSE)