notes README

The project's README from github.com/zhaoolee/notes. As one markdown file: README.md.

开源版锤子便签

支持手机版 一键发送公众号

通过DSH调用

可以在 DSH 的“插件市场”中搜索 notes 直接安装;源码仓库已经携带预编译产物, 无需开启 allowBuilds。也可以通过命令行安装 npm 版本:

dsh plugin --profile web add @zhaoolee/dsh-notes

安装后请重启目标 profile,使插件生效。重启后,在 DeepSeek Harness 对话中说:把我们的对话导出成便签, 智能体会自动整理当前对话并调用插件生成便签。

Deepseek Harness 生成分享便签 导出效果

通过skill调用

clawhub地址 https://clawhub.ai/zhaoolee/notes-export-api

从clawhub安装 notes-export-api这个 skill,
联网获取最近一周 AI 相关的新闻,将新闻转化为 markdown 生成便签图片,把便签图片绝对路径返回给我,把图片往“下载”文件夹复制一份

支持自定义底部品牌标识(点击就能改)

只要你喜欢,可以把底部的「锤子便签」改成「凿子便签」或「榔头便签」

支持下载文章,包含网页,markdown以及管理的图片资源

支持接入DeepSeek,修正语法错误,重点加粗,通俗化润色

零配置,复制即可将权限导入hermes agent

登陆后,复制一行专属链接,粘贴给Hermes Agent或OpenClaw,即可获取包含登身份认证的skill包,实现人机协同

支持多用户隔离

可以给AI分配一个账号,人类分配一个账号,数据严格隔离

支持一键粘贴到公众号助手

在手机的网页写完,直接一键粘贴到公众号即可发送,文本格式和图片,统统自动处理好!

支持子公司和各类知名主题

子公司主题 母公司主题

网页版

暖白纸感 深夜便签

Skill 服务地址

便签管理和 PNG 导出统一使用 NOTES_API_BASE_URL,可写入 skills/notes-export-api/.env,或通过 --base-url 传入:

NOTES_API_BASE_URL=http://127.0.0.1:18080

认证及完整配置见 skills/notes-export-api/SKILL.md。

使用 Docker Hub 镜像部署

单镜像同时包含 Web 前端和后端服务,便签管理、图片导入和 PNG 导出均可在本地 运行。公众号复制和 AI 等可选功能需另行配置相应服务。

需要登录、多端同步或 Skill 工作区管理时,先复制 .env.example,并配置 SUPERADMIN、SUPERADMINPASSWORD 和高熵 SESSION_SECRET:

cp .env.example .env
mkdir -p ./storage/images ./storage/data

docker run -d \
  --restart unless-stopped \
  --name notes \
  -p 127.0.0.1:18080:3001 \
  --env-file .env \
  -v "$(pwd)/storage/images:/app/storage/images" \
  -v "$(pwd)/storage/data:/app/storage/data" \
  zhaoolee/notes:latest

启动后访问 http://127.0.0.1:18080。storage/images 保存图片和导出的 PNG, storage/data 保存账号与云端工作区,两者都应持久化和备份。仅使用匿名编辑与导出 时可省略 --env-file .env;需要局域网访问时可将端口映射改为 -p 18080:3001,公网部署应使用 HTTPS 反向代理。

许可证

本项目自有代码采用 Apache License 2.0,版权声明见 NOTICE。

以下组件保留各自的许可证:

第三方依赖及图片、字体、图标等第三方资源不因本项目的代码许可证而被重新授权, 其权利与使用条件以各自权利方的许可为准。本项目的代码许可证不授予第三方商标权。

notes (zhaoolee/notes)

notes
Searching Database…

306 ·GitHub
What is this?This is an open-source clone of Smartisan's (锤子便签) famous notes app, recreating its design with multiple notes, categorized storage, and export styles that mimic warm paper, dark-night notes, iPhone Notes and Bear's minimal layout.
Is this an app I install, or something I just open in a browser?It is a pure web app — no installation is needed, you just open it in a browser on PC or mobile, with data syncing across devices.
How do I deploy this?Pull the Docker Hub image, which bundles both the web frontend and backend into a single container for local use. For login, multi-device sync or Skill workspace management, copy .env.example and configure SUPERADMIN, SUPERADMINPASSWORD and a high-entropy SESSIONSECRET before starting.
Do I need anything besides Docker to run it?Docker is the only requirement for anonymous editing and export; adding .env is only needed for login, LAN/public access or AI polishing features.
Is there anything extra to set up before exposing it on the public internet?Yes — public deployment should sit behind an HTTPS reverse proxy, and both the storage/data folder (accounts, workspaces) and the saved images directory need to be persisted and backed up.
How does an AI agent like OpenClaw actually create notes through this?After logging in, you copy a personal link with embedded authentication and give it to Hermes Agent or OpenClaw; this grants the agent a signed Skill package so it can call the API directly, e.g. to export a chat as a note.
Can I change the 'Smartisan Notes' branding?Yes, the footer brand text is editable with a single click, so you can rename it to anything you like.
What formats can a note be exported to?Notes can be exported as PNG images, copied as Markdown, downloaded as an offline HTML page, or bundled into a Markdown resource package that includes the images.
Can an AI and a human share the same workspace safely?No — the app supports multi-tenant isolation, so you can give the AI one account and a human another with strictly separated data.
Creator
zhaoolee
Size
60.6 MB
Stars
306
Age
7mo
Commits · 90 Days