支持的 Markdown 写法
markdown6 能正确显示和导出的写法:表格、代码、公式、12 种图表、图片与少量 HTML,以及暂不支持的写法。
下面每个例子左边是写法,右边是 markdown6 显示的效果;导出的 PDF、Word 与单文件 HTML 与预览一致。可以把左边的写法直接复制到软件里试一试。
#标题与段落
用 # 到 ###### 表示一级到六级标题。和很多编辑器不同,单个换行就是换行,不需要在行尾加两个空格;段落之间空一行。
### 三级标题 第一行 第二行紧接着显示在下一行。 空一行开始新的段落。
三级标题
第一行
第二行紧接着显示在下一行。
空一行开始新的段落。
#强调、列表与任务
**加粗**、*斜体*、~~删除线~~、`行内代码` - 无序列表 - 缩进两格成为子项 1. 有序列表 2. 第二项 - [x] 已完成的任务 - [ ] 未完成的任务
加粗、斜体、删除线、行内代码
- 无序列表
- 缩进两格成为子项
- 有序列表
- 第二项
- 已完成的任务
- 未完成的任务
工具栏 插入 菜单可以插入粗体(⌘B)、斜体(⌘I)、删除线、列表、引用、链接、代码块和表格。
#表格
| 阶段 | 主要工作 | 周期 | | --- | :---: | ---: | | 调研 | 业务访谈 | 2 周 | | 设计 | 方案评审 | 3 周 |
| 阶段 | 主要工作 | 周期 |
|---|---|---|
| 调研 | 业务访谈 | 2 周 |
| 设计 | 方案评审 | 3 周 |
第二行的冒号控制对齐::---: 居中,---: 右对齐。表格太宽时可以左右滚动。
#代码与高亮
用三个反引号包住代码,并写上语言名称:
```python
def roi(gain: float, cost: float) -> float:
return (gain - cost) / cost * 100
```def roi(gain: float, cost: float) -> float:
return (gain - cost) / cost * 100
支持高亮的语言:HTML、CSS、JavaScript、TypeScript、JSON、YAML、SQL、Bash、Java、Python、Go 与类 C 语法;其他语言按纯文本显示。预览中的代码块右上角有 复制 按钮。
#数学公式
行内公式用 $…$,独占一段的公式用前后各一行 $$(也可以写成语言为 math 的代码块),写法与 LaTeX 一致:
质能方程 $E = mc^2$ 写在句子里。
$$
ROI = \frac{\text{年化收益} - \text{投入成本}}{\text{投入成本}} \times 100\%
$$质能方程 写在句子里。
不熟悉 LaTeX 的,用工具栏 公式 › 公式编辑器…:按分类(常用符号、希腊字母、分数微分、根式角标、积分运算、数组矩阵等)点选符号,下方实时预览,点 插入。
#Mermaid 图表
用语言为 mermaid 的代码块书写图表,颜色跟随当前主题。工具栏 图表 菜单提供 12 种模板:流程图、时序图、甘特图、类图、状态图、饼图、旅程图、Git 图、思维导图、时间线、XY 图、象限图。
```mermaid
flowchart LR
A[需求访谈] --> B[方案评审]
B --> C{是否通过}
C -->|是| D[分批实施]
C -->|否| A
``````mermaid sequenceDiagram 客户->>顾问: 提出需求 顾问->>团队: 拆分任务 团队-->>顾问: 交付初稿 顾问-->>客户: 发送 PDF ```
```mermaid pie title 预算构成 "人力" : 55 "软件" : 25 "差旅" : 20 ```
#图片

{width=50%}
- 图片路径相对于文档所在的文件夹;路径里有空格时用
<…>包住。 - 末尾的
{width=100%}、{width=50%}、{width=original}分别表示适应版心、半页宽和原始尺寸,也可以在预览里选中图片后用尺寸条调整。 - 截图可以直接粘贴,图片文件可以直接拖进编辑区,markdown6 会把它们保存到文档旁边的
<文档名>.assets文件夹并写好引用。
#链接与目录跳转
[markdown6 官网](https://markdown6.com) 跳到本文的 [表格](#表格) 一节。
跳到本文的 表格 一节。
每个标题都会自动生成锚点,用 #标题文字 可以在文档内跳转;工具栏 大纲 也能按标题跳转。预览中点击外部链接,会用系统浏览器打开。
#可以使用的 HTML
为了安全,只保留少量常用 HTML 标签,例如折叠内容、上下标、按键与高亮;脚本、样式和内嵌网页会被去掉。
按 <kbd>⌘</kbd> + <kbd>S</kbd> 保存,<mark>重点</mark>可以高亮,H<sub>2</sub>O 与 x<sup>2</sup>。 <details> <summary>点击展开补充说明</summary> 折叠起来的内容。 </details>
按 ⌘ + S 保存,重点可以高亮,H2O 与 x2。
点击展开补充说明
折叠起来的内容。
#暂不支持的写法
- 脚注(
[^1])和提示块(> [!NOTE])会按普通文字或引用显示。 - 文档开头的
---头信息会按普通内容显示。 <script>、<iframe>、style属性等会被去掉,javascript:链接不会生效。
#写错了会怎样
公式或图表写错时,预览中对应位置会显示“公式错误(第 N 行)”或“图表错误(第 N 行)”和错误原因,点 定位到源码 跳到出错的那一行;其他内容不受影响,源码也不会被改动。
有公式或图表错误、或缺少图片时,导出会先提示你修正。
仍有问题?发邮件到 hi@miniidealab.com,或查看联系我们。