HackMD Integration
Requirements
CODEBLOCK0
Quick Reference
Read Notes
CODEBLOCK1
Write Notes
CODEBLOCK2
Team Notes
CODEBLOCK3
Change Tracking
Use hackmd-track.js (in scripts/) to detect document changes efficiently.
Track a Note
CODEBLOCK4
Check for Changes
CODEBLOCK5
Manage Tracking
CODEBLOCK6
How It Works
- 1.
hackmd-track.js add stores note's lastChangedAt timestamp - INLINECODE4 compares current
lastChangedAt with stored value - If changed: outputs content and updates stored timestamp
- If unchanged: outputs nothing (use
--verbose for status)
State stored in ./.hackmd/tracked-notes.json (current working directory)
Note Metadata Fields
When using --output json, notes include:
| Field | Description |
|---|
| INLINECODE9 | Unix timestamp of last modification |
| INLINECODE10 |
{name, userPath, photo} of last editor |
|
titleUpdatedAt | When title changed |
|
tagsUpdatedAt | When tags changed |
Rate Limits
- - 100 calls per 5 minutes
- 2000 calls/month (10k on Prime plan)
HackMD 集成
环境要求
bash
npm install -g @hackmd/hackmd-cli
快速参考
读取笔记
bash
列出所有个人笔记
hackmd-cli notes
获取笔记元数据（包含 lastChangedAt）
hackmd-cli notes --noteId=
--output json
获取笔记内容（Markdown 格式）
hackmd-cli export --noteId=
列出团队
hackmd-cli teams
列出团队笔记
hackmd-cli team-notes --teamPath=
写入笔记
bash
创建笔记
hackmd-cli notes create --content=# 标题
从文件创建
cat file.md | hackmd-cli notes create
更新笔记
hackmd-cli notes update --noteId= --content=# 已更新
删除笔记
hackmd-cli notes delete --noteId=
团队笔记
bash
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/ 目录）高效检测文档变更。
追踪笔记
bash
node scripts/hackmd-track.js add
检查变更
bash
单篇笔记 - 仅在变更时输出内容
node scripts/hackmd-track.js changes
所有追踪的笔记
node scripts/hackmd-track.js changes --all
JSON 格式输出便于解析
node scripts/hackmd-track.js changes --json
管理追踪
bash
node scripts/hackmd-track.js list # 显示追踪的笔记
node scripts/hackmd-track.js remove # 停止追踪
node scripts/hackmd-track.js reset # 重置（下次检查将显示为已变更）
工作原理
- 1. hackmd-track.js add 存储笔记的 lastChangedAt 时间戳
- hackmd-track.js changes 比较当前 lastChangedAt 与存储值
- 如果已变更：输出内容并更新存储的时间戳
- 如果未变更：不输出内容（使用 --verbose 查看状态）
状态存储在 ./.hackmd/tracked-notes.json（当前工作目录）
笔记元数据字段
使用 --output json 时，笔记包含以下字段：
| 字段 | 描述 |
|---|
| lastChangedAt | 最后修改的 Unix 时间戳 |
| lastChangeUser |
最后编辑者 {name, userPath, photo} |
| titleUpdatedAt | 标题变更时间 |
| tagsUpdatedAt | 标签变更时间 |
速率限制
- - 每 5 分钟 100 次调用
- 每月 2000 次调用（Prime 计划为 10,000 次）
