Slate

Markdown 语法参考

在 Slate 中轻松使用 Markdown 语法,让您的文档更加结构化和美观

标题

语法

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

文本样式

语法

**粗体文本**
*斜体文本*
***粗斜体文本***
~~删除线文本~~
`行内代码`

> 这是引用文本
> 
> 可以多行引用

效果

粗体文本

斜体文本

粗斜体文本

删除线文本

行内代码

这是引用文本
可以多行引用

列表

无序列表

语法:

- 项目一
- 项目二
  - 子项目 2.1
  - 子项目 2.2
- 项目三

效果:

  • 项目一
  • 项目二
    • 子项目 2.1
    • 子项目 2.2
  • 项目三

有序列表

语法:

1. 第一项
2. 第二项
   1. 子项目 2.1
   2. 子项目 2.2
3. 第三项

效果:

  1. 第一项
  2. 第二项
    1. 子项目 2.1
    2. 子项目 2.2
  3. 第三项

任务列表

语法:

- [ ] 未完成任务
- [x] 已完成任务
- [ ] 另一个未完成任务
  - [x] 子任务已完成
  - [ ] 子任务未完成

效果:

代码

行内代码

使用 `console.log()` 输出信息
使用 console.log() 输出信息

代码块

```javascript
function greet(name) {
    console.log("Hello, " + name);
}
greet("World");
```
function greet(name) {
    console.log("Hello, " + name);
}
greet("World");

缩进代码块

    function example() {
        return "四个空格缩进";
    }
function example() {
    return "四个空格缩进";
}

表格

基础表格

语法:

| 姓名 | 年龄 | 城市 |
|------|------|------|
| 张三 | 25   | 北京 |
| 李四 | 30   | 上海 |

效果:

姓名 年龄 城市
张三 25 北京
李四 30 上海

对齐方式

语法:

| 左对齐 | 居中对齐 | 右对齐 |
|:-------|:--------:|-------:|
| 左     |    中    |    右 |
| 内容   |   内容   |  内容 |

说明:

:--- 左对齐

:---: 居中对齐

---: 右对齐

高级语法

水平分割线

语法:

---
或
***
或
___

效果:


转义字符

语法:

\*不是斜体\*
\#不是标题
\[不是链接\]

效果:

*不是斜体*

#不是标题

[不是链接]

数学公式

行内公式:

$E = mc^2$

块级公式:

$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$

效果:

行内公式:E = mc²

块级公式:

n! / (k!(n-k)!) = C(n,k)

脚注

语法:

这是一个脚注示例[^1]。

[^1]: 这是脚注的内容。

说明:

脚注会自动编号并在页面底部显示详细内容。

Slate 特有功能

页面链接

语法:

[[页面名称]]
或
[[页面名称|显示文字]]

说明:

双方括号语法可以快速链接到其他页面

标注块

语法:

> 💡 这是一个提示标注
> 
> 内容可以多行显示

效果:

💡 这是一个提示标注
内容可以多行显示

使用技巧

最佳实践

  • • 使用一致的标题层级结构
  • • 在列表项后添加空行以获得更好的可读性
  • • 为图片添加有意义的替代文字
  • • 使用引用块来突出重要信息
  • • 合理使用表格来组织数据

Slate 中的 Markdown

Slate 支持实时 Markdown 渲染,您可以在输入时看到格式化效果。 也可以通过斜杠命令快速插入 Markdown 元素。