Description

The Square plugin turns recurring personal projects into clickable cards on a simple dashboard inside your vault. Each card points to one Markdown note and acts as a quick entry point for daily records, so you can log completion, counts, short text, date changes and attachments without leaving your notes. It is aimed at people who want habit and routine tracking to stay close to journals, reviews and project notes instead of sitting in a separate app. The plugin also adds weekly, monthly and ranking views for looking back on patterns, and it lets you archive projects once they move out of daily use. Records stay in normal Markdown files and the plugin states that it does not include client telemetry.

Latest Version

0.2.2

2 days ago

Changelog

设置页

在 Obsidian 1.13 及以上版本，设置页的各项设置会出现在 Obsidian 的设置搜索结果里，可以直接搜到「打卡记录目录」「启动时打开 Square」等选项；1.12 及以下版本保持原来的设置页。
设置窗口左侧的 Square 页签显示插件图标。

插件信息

插件短描述改为中英双语，插件列表里会同时显示中文和英文说明。

See all version on GitHub

Square 小方块

在 Obsidian 里完成日常打卡。

每个小方块代表一件你要持续做的事——阅读、运动、写作、喝水，或者任何项目。点一下，填记录，数据直接写回对应的 Markdown 笔记。

1. 怎么用

一个项目 = 一篇 Markdown 笔记。小方块是这篇笔记在日常界面上的入口。

点击方块弹出记录窗口，填完保存后，内容写回笔记。需要回看时，打开周视图或月视图。

2. 主要功能

标注 🔒 的功能需要授权码，其余安装后即可使用。

功能	说明
🟦 项目方块	主界面展示项目卡片，一眼看到今日待记录项；支持拖拽排序，也可以直接拖入归档区
📝 快速记录	支持确认、计数、文字、日期调整、附件；每个项目还可以在笔记里预定义自己的固定字段
📊 数据视图	周视图、月视图；主区和右侧统计页共用同一套总览
📅 未来排期 🔒	在月视图中编辑未来日期的安排，需要授权
📄 笔记写回	所有记录保存为普通 Markdown，与日记、复盘共存
🏷️ 项目模板	初始化时选择记录方式，减少日常配置
🗄️ 归档	移出日常视野，保留历史数据

3. 与一般打卡软件的区别

Square	一般打卡软件
数据留在 Obsidian Markdown 里	数据锁在独立 App 或云端
无提醒、无积分、无社交	强提醒、补签、排行榜、勋章
主界面轻，图表仅用于复盘	图表和通知占主界面
可记录次数、文字、附件	通常只能勾选

4. 适合谁

已经在 Obsidian 里记录生活、目标或项目
觉得任务列表太冷，独立打卡 App 又太脱离笔记库
不只想知道“有没有做”，还想留下“做了多少、当时怎么想”

5. 授权与隐私

状态	可用功能
🔓 未授权	最多 2 个项目，试用核心流程
🔒 授权后	项目数量不设上限，并解锁月视图未来排期编辑

授权密钥通过 Obsidian SecretStorage 本地保存并验证
项目记录为本地 Markdown 笔记
插件设置保存在本地 Obsidian 数据中
无客户端遥测

[!CAUTION] 请勿公开 .obsidian/plugins/square/data.json。该文件可能包含设置、授权状态及旧版本遗留的配置数据。

获取授权密钥：小红书搜索 焦应行

6. 安装

Square 需要 Obsidian 1.11.4 或更高版本。

6.1 社区插件（推荐）

打开 Obsidian 设置，进入“第三方插件”。
搜索 Square。
安装并启用插件。

6.2 BRAT

安装社区插件 BRAT。
打开 BRAT → Add Beta plugin。
输入 https://github.com/jiaoyingxing/square。
安装完成后，在 Obsidian 设置中启用 Square。

BRAT 可自动从 GitHub Releases 更新，无需手动替换文件。

6.3 手动安装

从 GitHub Releases 下载 main.js、manifest.json、styles.css。
放入 vault 的 .obsidian/plugins/square/ 目录。
重启 Obsidian 或重新加载插件。
启用 Square。

请使用 Release assets 中的安装文件，不要使用 GitHub 自动生成的源码压缩包。

7. 许可

闭源分发，源码不公开
不提供源码授权，不允许修改后再分发
详见 LICENSE

8. 联系

Bug、可复现问题和功能建议：GitHub Issues
授权码获取与使用交流：小红书搜索 焦应行 🔍

Square