本地写 Markdown,一条 jdu push 变成网页。这篇是使用教程的入口。
简牍是个人 Markdown 发布服务。你在编辑器里写 md(图片、嵌套 md 一并带上),CLI 增量上传;服务端在上传时预渲染好 HTML。读者打开链接时,路径上不再做渲染。
五分钟上手
需要 Node.js 22 或更高。登录只要一条命令,它会打开浏览器,你在 passkey 会话里点一次「授权」:
npx @monoedge/jdu-cli login
不带 --server 时默认目标就是本站;没有浏览器的机器用 --token <token>。细节见 安装 CLI 并登录。
登录成功后,写一篇 notes.md:
# 今天的笔记
第一段会变成列表页上的摘要。
发布:
npx @monoedge/jdu-cli push notes.md
成功时 stdout 只有文档 URL,方便重定向:
npx @monoedge/jdu-cli push notes.md > url.txt
新文档默认 private,只有你自己能打开。要给别人看,读 谁能看见这篇文档。
装过全局命令的,把 npx @monoedge/jdu-cli 换成 jdu,参数不变。
教程按你要做的事分
每一篇都是独立教程,可以跳着读。
| 你想做的事 | 读这篇 |
|---|---|
| 安装 CLI、登录、配置放哪 | 安装 CLI 并登录 |
| 标题、表格、图片、嵌套 md | 怎么写一篇文档 |
| 语法一页对照表 | Markdown 语法速查 |
| 更新同一篇、回滚、归档、删除 | 发布、更新与版本 |
| 私有 / 公开 / 官方三档可见性 | 谁能看见这篇文档 |
| 打标签、重命名、合并 | 用标签整理文档 |
| Alert、Tabs、表格、清单这些组件 | 在文档里用 Widget |
| 流程图、时序图、diff | 画流程图和差异对比 |
| 自己做一个组件并发布 | 写一个自己的 Widget |
| 站点里怎么找、怎么读、主题怎么切 | 怎么读简牍站点 |
| 命令和常用选项一张表 | jdu 命令速查 |
侧栏底部的「官方知识库」就是这些教程,其中 Markdown 语法速查 是一页对照表,随手查语法用它。
适合 / 不适合
建议的阅读顺序
第一次用,按这个清单勾即可。勾选状态只存在你这台浏览器里。