Skip to main content

📚 BookStack 支持的 Markdown 语法详解

✅  1. 标题

Markdown 标题通过 # 来表示,支持 1~6 级标题。

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


✅ 2. 段落与换行

  • 段落之间空一行即可分段。

  • 在一行末尾添加两个空格后换行,可实现强制换行。


3. 强调

  • 加粗**加粗内容**__加粗内容__

  • 斜体*斜体内容*_斜体内容_

  • 删除线~~删除线内容~~


✅ 4. 列表

  • 无序列表:使用 *+- 都可以

  • 有序列表:使用数字加点,如 1. 2.

无序列表:
- 项目 1
- 项目 2
  - 子项目 2.1

有序列表:
1. 步骤 1
2. 步骤 2
   1. 子步骤 2.1


✅ 5. 链接与图片

  • 链接[链接文本](URL)

  • 图片![图片描述](图片URL)

     

    • BookStack 特别提示:若插入 BookStack 内部已上传的图片,直接使用页面上传后生成的图片链接即可。

     

示例:

[访问 BookStack 官网](https://www.bookstackapp.com)

![示例图片](https://www.bookstackapp.com/images/logo.png)


✅ 6. 引用

使用 > 生成引用块,可多层嵌套。

> 这是一个引用
>> 这是引用中的引用


✅ 7. 代码

  • 行内代码:使用反引号 ` 包裹。

  • 代码块:使用三个反引号 ```,可指定语言以支持语法高亮。

行内示例:`console.log('Hello World')`

多行代码块:
```javascript
function greet() {
  console.log('Hello BookStack!');
}
---

### ✅ **8. 表格**
BookStack 支持标准 Markdown 表格语法。

```markdown
| 姓名   | 年龄 | 职业       |
| ------ | ---- | ---------- |
| Alice  | 25   | 开发者     |
| Bob    | 30   | 运维工程师 |


✅ 9. 分隔线

使用 ---***___ 来插入分隔线。

---

***

___


✅ 10. 任务列表

BookStack 支持 GitHub 风格的任务列表。

- [x] 已完成任务
- [ ] 待办任务


✅ 11. 内部锚点(链接到同页面内的标题)

BookStack 支持页面内锚点,自动为标题生成 ID,可直接 [标题文本](#标题) 来跳转。

示例:

假如你有一个标题 ## 使用方法,可以 [点击这里跳转](#使用方法)


⚡️ BookStack 中 Markdown 的特别要点


✅ 支持 Markdown 与 WYSIWYG 编辑器自由切换(建议尽量只用一种,防止格式混乱)。

✅ 图片和文件建议先通过页面上传再引用,避免外链失效。

✅ 支持自定义 HTML,但需谨慎使用,防止页面渲染异常。

✅ 对于需要复杂布局的内容(如多栏布局),可使用自定义 HTML 块。