Skip to content

Repository files navigation

语言: 简体中文 · English

Square 小方块

在 Obsidian 里完成日常打卡。


你已经在笔记库里写目标、记日记、做复盘,但每天记录「今天做了没」时,还得打开另一个 App。

Square 把这些行动接回 Obsidian:主界面放一组小方块,每个方块代表一件你要持续做的事——阅读、运动、写作、喝水,或者任何项目。

点一下,填记录,数据直接写回对应的 Markdown 笔记。

不追求提醒、积分、排行榜或社交打卡。只是一个轻量的日常记录入口。

⚙️ 怎么用

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

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

✨ 功能

功能 说明
🟦 项目方块 主界面展示项目卡片,一眼看到今日待记录项
📝 快速记录 支持确认、计数、文字、日期调整、附件
📊 数据视图 周视图、月视图、排行视图,用于复盘
📄 笔记写回 所有记录保存为普通 Markdown,与日记、复盘共存
🏷️ 项目模板 初始化时选择记录方式,减少日常配置
🗄️ 归档 移出日常视野,保留历史数据

🌱 与一般打卡软件的区别

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

🧭 适合谁

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

🔐 授权与隐私

状态 可用功能
🔓 未授权 少量项目,试用核心流程
🔒 授权后 完整项目数量与全部功能
  • 授权密钥通过 Obsidian SecretStorage 本地保存并验证
  • 项目记录为本地 Markdown 笔记
  • 插件设置保存在本地 Obsidian 数据中
  • 无客户端遥测
  • ⚠️ 请勿公开 .obsidian/plugins/square/data.json

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

🚀 安装

⚠️ Square 为闭源插件,不在官方 Community Plugins 商店中。

BRAT(推荐)

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

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

手动安装

  1. GitHub Releases 下载 main.jsmanifest.jsonstyles.css
  2. 放入 vault 的 .obsidian/plugins/square/ 目录
  3. 重启 Obsidian 或重新加载插件
  4. 启用 Square

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

📜 许可

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

📮 联系

反馈与授权码获取:小红书搜索 焦应行

About

Installable runtime artifacts for Square, a lightweight Obsidian habit tracker.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages