首页 › 使用文档

snippets 使用文档

本文覆盖 Windows 单机版(单文件 exe)的全部功能与日常用法。软件只在本机运行,数据不出你的电脑。

1. 安装与启动

  1. 从官网下载 snippets-local.zip,解压到任意文件夹(建议放在固态盘以外的固定目录,比如 D:\snippets)。
  2. 双击 snippets-release.exe;也可以双击 start.bat,效果一样,还会自动打开浏览器。
  3. 软件会启动一个只监听本机的服务,默认地址 http://127.0.0.1:8091。外部电脑访问不了,安全。

常用启动参数

方式说明
-port 9000改端口(8091 被占用时用它)
环境变量 SNIPPETS_DATA_DIR把数据目录指到别处,例如网盘同步目录
环境变量 SNIPPETS_ALLOW_REG=0关闭本地账号注册(默认是开放的)
数据目录:默认就是 exe 旁边的 data\ 文件夹,数据库和上传的附件都在里面。要搬家,整个文件夹拷走即可。

2. 第一次使用

  1. 注册授权账号:首次运行弹出授权页,注册一个账号,立即获得 30 天全功能试用,无需付费、无需绑定支付方式。
  2. 创建本地管理员账号:设置你的用户名和密码,这才是存放内容的地方。
  3. 进入工作台:左侧是分组与标签,中间是列表,右侧是操作栏。
  4. 右上角「⚙ 账号」里可以改密码、导出导入备份、审核留言、配置站点。
两套账号别混淆:授权账号用于试用与激活(在服务器上),本地账号用于登录工作台(存在你的数据库里)。两者互不相干。

3. 界面速览

顶栏

从左到右:搜索框(搜标题、正文、标签)· 主题(终端绿 / 深海蓝 / 暖纸白 / 高对比)· 目录 · 批注 · ✎ 标注总览 · 看板 · 字典 · ☀ 今天 · ◷ 活动 · ❋ 导图 · + 新建 · ⚙ 账号。按钮多了会自动折行,不会被挤出屏幕。

左侧栏

右侧操作栏

选中某一篇后出现:★ 星标 · 编辑 · 复制全部 · 下载 · ⤓ HTML · ⤓ PDF · 历史 · ▶ 运行 · + 附件 · ⬆ 发布 · 删除。操作栏可拖动位置、点「»」收起。

4. 核心概念

概念说明
片段最小单位,默认只属于你自己,发布后才进公开页
分组用 / 分两级,如 后端 / SQLite
标签 / 语言逗号分隔;标签参与合集聚合,语言决定代码高亮
星标分组内置顶;右键或 Shift+点击换颜色
待办三态 ◇ 待办 / ◆ 在做 / ✓ 完成,可再挂一个到期日
批注行批注与划词批注两种,见第 6 节
备注写在片段上的备忘,与批注分开统计

5. 新建、编辑与附件

点「+ 新建」,三个字段都可以留空直接创建:标题留空用当天日期(如「周四15号」),分组留空自动归到「2026年 / 10月」。所以最快的操作是 + 新建 → 直接点创建。

Markdown 与代码块

正文用 Markdown 书写,```语言 代码块自动高亮、带行号、可折叠。Ctrl/⌘ + S 保存。

拖文件进来就能用

拖进来的文件会发生什么
.md / .markdown「插入正文」还是「当附件上传」,二选一
.docx / .xlsx / .xls「转成 Markdown」还是「当附件上传」(本地转换,不上传网络)
图片 / 音频 / PDF 等上传为附件,并把引用插进正文

粘贴图片与附件

在编辑器里 Ctrl + V 直接粘贴截图,图片会自动压缩后存入 data\uploads\,并把 Markdown 引用插到光标处。右侧「+ 附件」也可以上传视频、音频、PDF 等任意文件。

6. 批注系统

类型怎么产生锚定方式
行批注对着某一行点「✎ 批注」按行号锚定
划词批注选中一段文字后点「✎ 批注」按选中的文本锚定
批注回复在某条批注下点「回复」挂在父批注下

批注框里可以选颜色、写内容,Ctrl + Enter 保存。顶栏「批注」看本篇全部批注,「✎ 标注」跨篇搜索全部批注。Esc 关闭浮层。

隐私:批注随片段的可见性走 —— 片段没发布,批注就只有你自己看得见;批注故意不进公开页,只在导出 HTML / PDF 时随正文一起带出去。

7. 版本历史

操作栏「历史」打开全屏版本列表:左侧选版本,右侧左右分栏看它与当前内容的差异,带真实行号与语法着色,可一键恢复。每次保存都会自动快照,包括初稿。

8. 字典 / 看板 / 导图

字典页

目录树 + 全文检索 + 代码高亮,行首即可添加批注,支持单篇导出 HTML / PDF。顶部可按语言、标签、星标组合筛选。

卡片看板

按日期瀑布排列,每张卡片可直接复制代码、下载、跳转详情,适合快速回看某段时间写过的东西。

思维导图

分组 / 标签 / 语言自动生成导图,可拖拽平移、缩放聚焦,点节点直接预览内容。

今天 / 活动

「☀ 今天」汇总当天待办、提醒与动向;「◷ 活动」是完整的时间线,可按类型筛选、按天查看。

9. 发布成博客

  1. 打开片段 → 右侧操作栏点 「⬆ 发布」。
  2. 系统生成 12 位 slug(可自定义),公开地址形如 /post.php?slug=xxxxxxxxxxxx。
  3. 可复制公开链接、置顶到首页、或随时下线(内容与留言保留)。

发布后自动生成博客首页、合集页、RSS 与 sitemap,访客可以留言(留言需你在「⚙ 账号 → 留言审核」里通过后才会公开)。发布时可填 description(建议 80–160 字)和 keywords,会写进页面的 <meta>,对搜索引擎友好。

10. 数据与备份

内容位置
数据库数据目录下的 app.sqlite
上传附件data\uploads\

三种备份方式:

  1. 账号面板导出:⚙ 账号 → 数据备份 → 导出全量备份(JSON,含片段、批注与回复、留言、版本历史、分组星标、站点设置)。导入时可选「叠加」或「覆盖还原」。
  2. 整目录拷贝:把 data\ 整个复制走(含附件文件),这是最省事的方式。
  3. 定期两者都做:JSON 用于跨版本恢复,目录拷贝用于兜底。

11. 授权与换机

还有疑问?邮箱 493598104@qq.com · 微信 civbaby,也可以回首页常见问题看看。