HackMD 集成

前提要求

npm install -g @hackmd/hackmd-cli

快速参考

读取笔记

# 列出所有个人笔记
hackmd-cli notes

# 获取笔记元数据（包含 lastChangedAt）
hackmd-cli notes --noteId= --output json

# 获取笔记内容（Markdown 格式）
hackmd-cli export --noteId=

# 列出团队
hackmd-cli teams

# 列出团队下的笔记
hackmd-cli team-notes --teamPath=

写入笔记

# 创建笔记
hackmd-cli notes create --content='# 标题'

# 从文件创建
cat file.md | hackmd-cli notes create

# 更新笔记
hackmd-cli notes update --noteId= --content='# 已更新'

# 删除笔记
hackmd-cli notes delete --noteId=

团队笔记

hackmd-cli team-notes create --teamPath= --content='# 团队笔记'
hackmd-cli team-notes update --teamPath= --noteId= --content='...'
hackmd-cli team-notes delete --teamPath= --noteId=

变更追踪

使用 hackmd-track.js（位于 scripts/ 目录下）高效检测文档变更。

追踪某篇笔记

node scripts/hackmd-track.js add 

检查变更

# 单篇笔记 —— 仅当发生变更时输出内容
node scripts/hackmd-track.js changes 

# 所有已追踪的笔记
node scripts/hackmd-track.js changes --all

# 输出 JSON 格式，便于程序解析
node scripts/hackmd-track.js changes  --json

追踪管理

node scripts/hackmd-track.js list              # 显示当前追踪的笔记列表
node scripts/hackmd-track.js remove    # 停止追踪该笔记
node scripts/hackmd-track.js reset     # 重置追踪状态（下次检查将视为已变更）

工作原理

1. hackmd-track.js add 将笔记的 lastChangedAt 时间戳保存至本地
2. hackmd-track.js changes 将当前 API 返回的 lastChangedAt 与本地存储值进行比对
3. 若发生变更：输出笔记内容，并更新本地存储的时间戳
4. 若未发生变更：不输出任何内容（可添加 --verbose 参数查看状态信息）

状态信息保存在 ./.hackmd/tracked-notes.json（当前工作目录下）

笔记元数据字段

使用 --output json 时，返回的笔记对象包含以下字段：

调用频率限制

• 每 5 分钟最多 100 次调用
• 每月最多 2000 次调用（Prime 计划为 10,000 次）