支持的 Markdown
Resomark 读写的是普通的 Markdown 文件:支持 CommonMark 和 GitHub 风格的 Markdown(表格、任务列表、删除线),另外支持 Obsidian、Typora 这类编辑器里常见的写法:高亮、脚注、数学公式、Mermaid 图表、Callout、frontmatter 和 [[双链]]。不加私有格式,文件换任何编辑器都能打开。
| 写法 | 例子 | 说明 |
|---|---|---|
| 标题 | # 标题 到 ###### 标题 |
也认下一行写 === / --- 的标题 |
| 引用 | > 文字 |
可以多层嵌套 |
| 无序列表 | - 项目(也可用 *、+) |
|
| 有序列表 | 1. 项目 |
编号会自动接上 |
| 任务列表 | - [ ] 待办、- [x] 完成 |
方框点一下就勾上 |
| 代码块 | 三个反引号 ``` 加语言名 |
按语言高亮 |
| 分割线 | --- |
|
| 表格 | GitHub 风格的表格 | 直接在格子里编辑 |
| 数学公式 | $$ … $$,$$ 各自单独一行 |
用 KaTeX 排版 |
| Mermaid 图表 | 代码块的语言写 mermaid |
画出图来;出错时显示原文和错误 |
| Callout | > [!NOTE] 下面每行都以 > 开头 |
五种:NOTE、TIP、IMPORTANT、WARNING、CAUTION |
| frontmatter | 文件开头用 --- 围起来的 YAML |
原样显示,不折叠 |
| 脚注 | 正文 [^1],文末 [^1]: 说明 |
行内
「行内」一节| 写法 | 例子 |
|---|---|
| 粗体、斜体 | **粗体**、*斜体* |
| 删除线 | ~~删除~~ |
| 高亮 | ==高亮== |
| 下划线 | <u>下划线</u> |
| 行内代码 | `代码` |
| 上标、下标 | ^上标^、~下标~ |
| 行内公式 | $E=mc^2$ |
| 链接 | [文字](https://example.com)、[文字](其他文件.md#标题) |
| 双链 | [[文件名]]、[[文件名|显示的文字]]、[[文件名#标题]] |
| 图片 | ; 指定大小;![[a.png]] 也行 |
| 网址 | 直接写 https://… 就是链接 |
| Emoji | :smile: 显示成 😄 |
双链的写法和补全见链接与反向链接。
文档里的 HTML
「文档里的 HTML」一节Markdown 里写的 HTML 和 SVG 会直接显示出来。带脚本的 HTML 放在一个隔离的环境里运行,碰不到 Resomark 和你的其他文件;放大查看时可以展开成单独的窗口。代码块里的 HTML 只当代码显示,不运行。
和别的地方不一样的
「和别的地方不一样的」一节- 缩进代码块不支持:前面空四格的文字仍是普通段落(笔记里常有深缩进)。代码请用三个反引号。
- Callout 只认五种:Obsidian 里别的类型(比如
[!info]、[!question])显示成普通引用。 - 嵌入只认图片:
![[图片.png]]显示图片;![[笔记]]不会把那篇笔记嵌进来。 - 标签:
#标签只是普通文字,没有标签面板。