一页对照表:简牍支持的 Markdown 写法、几个扩展块,以及 Widget 的调用方式。想要更细的说明看 怎么写一篇文档。
基础
| 要什么 | 怎么写 |
|---|---|
| 标题 | # 一级 ## 二级 ### 三级 |
| 强调 | **粗体** *斜体* ~~删除线~~ |
| 链接与图片 | [文字](url)  |
| 列表 | - 无序 1. 有序 - [ ] 待办 |
| 引用 | > 引用一段 |
| 行内代码 | 反引号包起来 |
| 表格 | 一行 ` |
| 脚注 | 正文 [^1],另起一行 [^1]: 注解 |
| 分隔线 | --- |
代码块用三个反引号,语言标识写在第一行后面:
```ts
export const hello = '世界';
```
图片和附件写相对路径即可。jdu push 会把同目录下被引用到的文件一起传上去,正文里的引用改写成 /blob/<hash>——下载下来的 md 图片照样能开。
流程图、差异对比这类图表也是代码块,见 画流程图和差异对比。
Widget
代码块的语言标识写成 widget:名字,正文是一份 JSON 对象:
```widget:Alert
{
"message": "提示内容",
"type": "info"
}
```
写错名字或 JSON 不合法时,这一块退化成普通代码块,整页其它部分照常。每个组件的字段与示例见 在文档里用 Widget。
这台实例上有哪些组件是运行期的数据,不写死在这篇里:打开 /api/syntax 就是本实例的实时清单(匿名可读、markdown 文本),jdu mcp 的 get_syntax 原样透传同一份。要完整的字段 schema 看 /api/widgets。
发布
npm i -g @monoedge/jdu-cli
jdu login --server <你的简牍地址>
jdu push notes.md --visibility public --tag 架构
jdu login 会起一个本机回调端口并打开浏览器等你点「授权」,token 自动写进本地配置。没有浏览器的机器(CI、远端 ssh)用 jdu login --server <地址> --token <token>,token 向管理员申领。完整步骤见 安装 CLI 并登录,命令逐条见 jdu 命令速查。
教程目录:使用简牍