鹅的笔记 · goose-note

A local-first, Notion-style note-taking app — built as a uTools plugin, also runnable in the browser.

本地优先的 Notion 风格笔记应用，基于 BlockNote 块编辑器构建，内置 AI 能力，可作为 uTools 插件运行，也支持浏览器端使用。

✨ 特性

• 块编辑器：基于 BlockNote 的所见即所得编辑，支持标题、列表、折叠块、代码块等
• 本地优先：笔记存储在本地，支持挂载本地文件夹作为记事本
• AI 能力：集成 AI SDK（OpenAI Responses / OpenAI-compatible / Anthropic），支持续写、改写、问答
• 快速速记：独立的速记小窗（鹅的小窗），随手记录、一键入库
• 全局搜索：跨记事本搜索标题与正文，跳转即定位
• 深色模式：完整的明暗主题适配

🛠 技术栈

• 编辑器：BlockNote（ProseMirror）+ Tiptap 扩展
• 框架：React + TypeScript + Vite
• 状态管理：Zustand
• UI：Radix UI + HeroUI + Tailwind CSS
• AI：Vercel AI SDK
• 宿主：uTools（可选）/ 浏览器

🚀 本地开发

# 安装依赖（推荐 bun）
bun install

# 启动开发服务器（http://localhost:6001）
bun run dev

# 构建（产出 uTools 插件包）
bun run build

uTools 插件调试

浏览器 bun run dev 适合改 UI，但 uTools 真机行为（preload、主题、窗口等）需在插件环境里验证：

1. 执行 bun run build（会生成 dist/ 下的完整插件包，含 dist/plugin.json）
2. 打开 uTools 开发者工具
3. 加载插件，选择本仓库的 dist/plugin.json
4. 在开发者工具中 打开 该插件，即可看到最新构建效果

改代码后重复步骤 1，再在开发者工具里重新打开插件（或按工具提示刷新）即可。

速记小窗（B 插件）产物在 dist-quicknote/plugin.json，加载方式相同。

📦 构建产物

bun run build 会执行 tsc 类型检查 + vite build + uTools 打包脚本，产出可加载到 uTools 的插件包。

提交前请确保以下检查通过（CI 也会跑这些）：

bun run typecheck   # tsc -b --noEmit
bun run lint        # eslint .
bun run test:unit   # 单元测试
bun run test:e2e    # 浏览器端到端测试
bun run build

🔒 项目状态

本项目是闭源专有软件，不接受未经授权的使用、复制、修改或分发，也不接受外部代码贡献。报告安全问题请参阅 SECURITY.md。

📄 许可证

专有软件，未经授权不得使用、复制、修改或分发。详见 LICENSE。