All Writer

主题

Markdown 语法指南 ​

All Writer 完整支持 Markdown 语法，本指南介绍常用的 Markdown 语法和扩展功能。

基础语法 ​

标题 ​

使用 # 创建标题，# 的数量表示标题级别：

markdown
# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

效果：

一级标题 ​

二级标题 ​

三级标题 ​

四级标题 ​

五级标题 ​
六级标题 ​

💡 提示：标题会自动显示在大纲面板中，方便快速导航。

段落和换行 ​

  • 段落：段落之间用空行分隔
  • 换行：行末添加两个空格，或使用空行
markdown
这是第一段。

这是第二段。

这是同一段的第一行。  
这是同一段的第二行。

强调 ​

使用 * 或 _ 表示强调：

markdown
_斜体文本_
_斜体文本_

**粗体文本**
**粗体文本**

**_粗斜体文本_**
**_粗斜体文本_**

效果：

斜体文本
粗体文本
粗斜体文本

列表 ​

无序列表 ​

使用 -、* 或 +：

markdown
- 项目 1
- 项目 2
  - 子项目 2.1
  - 子项目 2.2
- 项目 3

效果：

  • 项目 1
  • 项目 2
    • 子项目 2.1
    • 子项目 2.2
  • 项目 3

有序列表 ​

使用数字和点：

markdown
1. 第一项
2. 第二项
3. 第三项
   1. 子项 3.1
   2. 子项 3.2

效果：

  1. 第一项
  2. 第二项
  3. 第三项
    1. 子项 3.1
    2. 子项 3.2

任务列表 ​

使用 - [ ] 和 - [x]：

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

效果：

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

链接 ​

markdown
[链接文本](https://example.com)
[带标题的链接](https://example.com "链接标题")
<https://example.com>

效果：

链接文本
带标题的链接
https://example.com

图片 ​

markdown
![图片描述](image.png)
![带标题的图片](image.png "图片标题")

语法说明：

  • ![图片描述] - 图片的替代文本（当图片无法加载时显示）
  • (图片路径) - 图片的路径，可以是相对路径或绝对路径
    • 相对路径：./images/photo.png 或 images/photo.png
    • 绝对路径：/images/photo.png
    • 网络图片：https://example.com/image.png
  • "图片标题" - 鼠标悬停时显示的标题（可选）

💡 提示：All Writer 支持插入本地图片和网络图片。插入图片时，建议将图片文件放在项目目录中，使用相对路径引用。

引用 ​

使用 > 创建引用：

markdown
> 这是一段引用文本。
>
> 可以包含多个段落。
>
> > 嵌套引用也是支持的。

效果：

这是一段引用文本。

可以包含多个段落。

嵌套引用也是支持的。

代码 ​

行内代码 ​

使用反引号：

markdown
使用 `code` 表示行内代码。

效果：

使用 code 表示行内代码。

代码块 ​

使用三个反引号：

markdown
```javascript
function hello() {
  console.log("Hello, World!");
}
```

效果：

javascript
function hello() {
  console.log("Hello, World!");
}

语法高亮 ​

支持多种编程语言的语法高亮：

markdown
```python
def hello():
    print("Hello, World!")
```

```javascript
function hello() {
  console.log("Hello, World!");
}
```

```bash
echo "Hello, World!"
```

表格 ​

使用 | 和 - 创建表格：

markdown
| 列 1   | 列 2   | 列 3   |
| ------ | ------ | ------ |
| 数据 1 | 数据 2 | 数据 3 |
| 数据 4 | 数据 5 | 数据 6 |

效果：

列 1列 2列 3
数据 1数据 2数据 3
数据 4数据 5数据 6

对齐方式 ​

markdown
| 左对齐 | 居中 | 右对齐 |
| :----- | :--: | -----: |
| 左     |  中  |     右 |

效果：

左对齐居中右对齐
左中右

水平线 ​

使用三个或更多的 -、* 或 _：

markdown
---
---

---

效果：

扩展语法 ​

删除线 ​

使用 ~~：

markdown
~~删除的文本~~

效果：

删除的文本

高亮 ​

使用 ==：

markdown
==高亮的文本==

效果：

==高亮的文本==

注解（外部引用） ​

All Writer 支持在文档中使用外部引用注解，类似于学术论文中的引用标注。

语法：

markdown
这是需要标注的内容[[ref:引用标题]]。

这是另一个引用[[ref:另一个引用]]。

相同的引用标题会使用相同的序号[[ref:引用标题]]。

功能特点：

  • 自动编号：相同标题的引用使用相同序号，按出现顺序自动分配
  • 点击查看：点击上标数字可查看引用详情（标题、内容、链接等）
  • 项目级别：引用在项目级别管理，可在项目中复用

使用步骤：

  1. 在右侧面板打开"外部引用"面板
  2. 创建新的引用（输入标题、内容描述、链接等）
  3. 在文档中使用 [[ref:引用标题]] 语法插入引用
  4. 引用会自动渲染为带序号的上标（如 [1], [2]）
  5. 点击上标可查看引用详情

示例：

markdown
机器学习是人工智能的一个重要分支[[ref:人工智能概述]]。

深度学习作为机器学习的子领域[[ref:深度学习基础]]，近年来取得了突破性进展[[ref:人工智能概述]]。

渲染效果：

  • [[ref:人工智能概述]] → 显示为 [1]
  • [[ref:深度学习基础]] → 显示为 [2]
  • 再次使用 [[ref:人工智能概述]] → 仍然显示为 [1]

数学公式 ​

行内公式 ​

使用 $：

markdown
这是行内公式：$E = mc^2$

效果：

这是行内公式：$E = mc^2$

块级公式 ​

使用 $$：

markdown
$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$

效果：

$$ \int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi} $$

图表 ​

Mermaid 流程图 ​

markdown
```mermaid
graph TD
    A[开始] --> B{判断}
    B -->|是| C[操作1]
    B -->|否| D[操作2]
    C --> E[结束]
    D --> E
```

Mermaid 序列图 ​

markdown
```mermaid
sequenceDiagram
    participant A as 用户
    participant B as 系统
    A->>B: 请求
    B-->>A: 响应
```

HTML 支持 ​

All Writer 支持在 Markdown 中使用部分安全的 HTML 标签。出于安全考虑，所有 HTML 内容都会经过 DOMPurify 清理。

支持的 HTML 标签：

  • 文本标签：<p>, <span>, <div>, <br>, <hr>
  • 格式标签：<strong>, <em>, <u>, <s>, <code>, <pre>
  • 列表标签：<ul>, <ol>, <li>
  • 表格标签：<table>, <thead>, <tbody>, <tr>, <th>, <td>
  • 链接和图片：<a>, <img>
  • 其他：<details>, <summary>, <blockquote>

示例：

markdown
<div style="color: red;">
  这是红色文本
</div>

<details>
<summary>点击展开</summary>

这是折叠的内容。

</details>

<span style="background-color: yellow;">高亮文本</span>

注意事项：

  • 危险的标签（如 <script>, <iframe>, <object> 等）会被自动过滤
  • style 属性中的部分危险样式可能会被清理
  • 建议优先使用 Markdown 语法，HTML 仅用于 Markdown 无法实现的效果

HTML 注释（注解） ​

All Writer 支持在 Markdown 中使用 HTML 注释，注释内容不会在渲染时显示，但会保留在源代码中。

语法：

markdown
<!-- 这是一条注释，不会在渲染时显示 -->

这是一段正常文本。

<!--
  多行注释也是支持的
  可以包含多行内容
-->

用途：

  • 添加文档说明和备注
  • 临时隐藏某些内容
  • 为后续编辑添加提示
  • 标记待完成的内容

示例：

markdown
## 研究方法

<!-- 描述实验设计、数据采集方法、分析工具 -->

这是研究方法的正文内容。

## 实验结果

<!-- TODO: 需要添加数据图表 -->
<!-- 展示主要发现、数据图表、统计分析 -->

快捷键 ​

All Writer 提供了 Markdown 编辑的快捷键：

功能快捷键
加粗Ctrl + B
斜体Ctrl + I
插入链接Ctrl + K
插入代码块Ctrl + Shift + K
插入表格Ctrl + T
插入图片Ctrl + Shift + I

最佳实践 ​

1. 标题层级 ​

  • 使用合理的标题层级
  • 避免跳过层级（如从 H1 直接跳到 H3）
  • 建议不超过 4 级标题

2. 列表使用 ​

  • 使用有序列表表示步骤
  • 使用无序列表表示要点
  • 合理使用嵌套列表

3. 代码块 ​

  • 始终指定代码语言以获得语法高亮
  • 长代码块使用代码块而非行内代码
  • 添加必要的代码注释

4. 链接和图片 ​

  • 使用描述性的链接文本
  • 为图片添加 alt 文本
  • 使用相对路径引用本地资源

5. 表格 ​

  • 保持表格简洁
  • 使用对齐方式提高可读性
  • 避免过宽的表格

常见问题 ​

Q: Markdown 和 HTML 可以混用吗？ ​

A: 可以。All Writer 支持在 Markdown 中使用 HTML 标签，但建议优先使用 Markdown 语法。

Q: 如何插入特殊字符？ ​

A: 使用反斜杠转义，如 \* 表示字面量星号，而不是强调标记。

Q: 支持哪些代码语言？ ​

A: All Writer 支持主流编程语言的语法高亮，包括 JavaScript、Python、Java、C++、Go、Rust 等。

Q: 数学公式支持哪些语法？ ​

A: 支持 LaTeX 数学公式语法，包括分数、根号、积分、求和等。

Q: 图表支持哪些类型？ ​

A: 支持 Mermaid 流程图、序列图、甘特图、类图等多种图表类型。

相关资源 ​

💡 提示：Markdown 语法简单易学，建议多练习。All Writer 提供实时预览功能，可以边写边查看效果。

Copyright © 2025-present All Writer Team