编辑器语法帮助
InfoSphere 编辑器直接书写 Markdown 原文,右侧/分栏可实时预览。除标准语法外,
还内置了一组扩展组件(标签页、折叠面板、公式、流程图等),本文档覆盖全部可用语法。
一、基础语法
标题
行首 # 到 ###### 对应一级到六级标题(# 与文字之间留一个空格):
# 一级标题
## 二级标题
### 三级标题
#### 四级标题「本章目录」(
[toc])只会收录 二级和三级标题。
强调
| 效果 | 写法 | 快捷键 |
|---|---|---|
| 加粗 | **文字** |
Ctrl/⌘ + B |
| 斜体 | *文字* |
Ctrl/⌘ + I |
~~文字~~ |
— | |
行内代码 |
`代码` |
— |
选中文字后按 ( [ { ` * _ ~ " ' 任意配对符,会自动包裹选区。
列表
- 无序列表项
- 另一项
1. 有序列表项
2. 自动续号
- [ ] 未完成任务
- [x] 已完成任务- 在列表行尾按 回车 自动续行:有序列表自增序号,任务列表新建未勾选项
- 在 空列表项 上按回车,退出列表
- Tab / Shift+Tab 增减列表缩进;多行选区按 Tab 整体缩进
- 预览中任务复选框 可以点击,会同步改回正文里的
[ ]/[x]
引用
> 这是一段引用回车会自动续行 >;空引用行回车退出。
代码块
用三个反引号包裹,标注语言可获得语法高亮:
```js
console.log('hello')
```链接
[显示文字](https://example.com)快捷键 Ctrl/⌘ + K。外部链接(http/https 开头)自动新标签页打开。
表格
| 列一 | 列二 | 列三 |
| :--- | :---: | ---: |
| 默认左对齐 | 居中 | 右对齐 |
| 单元格支持 **行内** `格式` | a | b |冒号位置决定对齐方式,表头下的分隔行必需。
换行与分隔线
- 直接 回车即换行,无需行尾两个空格
- 三个以上
-单独成行为分隔线:---
二、提示块(Callout)
GitHub 风格
> [!NOTE]
> 备注内容
> [!TIP]
> 提示内容
> [!IMPORTANT]
> 重要内容
> [!WARNING]
> 警告内容
> [!CAUTION]
> 注意内容HTML 标签风格
<Note> <Tip> <Warning> <Info> <Caution> <Important> 六种,正文里
第一行的 **加粗** 会成为标题(可省略,省略时使用默认标题):
<Note>
**自定义标题**
这里是提示正文,支持 **加粗**、`代码`、列表等任意 Markdown。
</Note>三、目录与元信息
本章目录
在任意位置写:
[toc]会自动替换为本文 二级/三级标题 组成的可点击目录。
子章节目录
[children]阅读时会替换为当前章节 直接子章节 的链接列表;没有子章节时不显示。
编辑器预览中显示占位提示。
章节图标
在正文任意位置(通常放开头)加一条 HTML 注释,可替换左侧目录树中该章节的默认图标:
<!-- icon: database -->图标名为 Font Awesome 图标名(可省略 fa- 前缀),可选样式前缀,例如regular heart、brands github。这条注释不会显示在正文里。
章节内链
用标准链接语法加 doc: 前缀,阅读/预览时会自动转成站内阅读地址(新窗口不打开,站内跳转):
- 同一本书内跳转到某章节:
[想看的文字](doc:章节slug)
例:[见第二章](doc:chapter-two) → /book/reader/<当前书>/chapter-two - 跨书跳转:
[文字](doc:书slug/章节slug)
例:[参考另一本书的序](doc:other-book/intro)
说明:
章节slug是目标章节的 slug;同书写法依赖当前书籍上下文(阅读页、写作预览、打印均支持)。若在没有书籍上下文的地方(如站点公告)使用同书写法且未指定书籍,会自动降级为纯文本,避免死链。
四、高级组件
以下 ::: 开头的块都用单独一行 ::: 结束;块内可以再嵌套代码块或同名块。
标签页 Tabs
:::tabs
=== "第一个标签"
这里是第一个标签的内容
=== "第二个标签"
这里是第二个标签的内容
:::也支持从其他文档系统迁移的 HTML 写法(两种完全等价):
<Tabs>
<Tab title="第一个标签">
内容…
</Tab>
<Tab title="第二个标签">
内容…
</Tab>
</Tabs>折叠面板 Accordion
<AccordionGroup>
<Accordion title="点我展开">
折叠内容,支持任意 Markdown 与嵌套组件。
</Accordion>
<Accordion title="另一个面板">
内容…
</Accordion>
</AccordionGroup>步骤 Steps
<Steps>
<Step title="第一步">
做什么…
</Step>
<Step title="第二步">
再做什么…
</Step>
</Steps>网格卡片 Grid
块内的 列表项 会逐项变成卡片,列表项的续行并入同一张卡:
:::grid cols-3 gap-4
- **卡片一**\n卡片描述文字
- **卡片二**\n卡片描述文字
- **卡片三**\n卡片描述文字
:::参数:cols-1 到 cols-6(默认 2)、gap-0 到 gap-12(默认 4)、no-responsive 关闭响应式列宽。
行级差异 Diff
头部用 +行号 -行号 标注增删行(支持区间与逗号),或直接在行首写 + / -:
:::diff +2 -4,5
保持不变的上下文行
+新增的这一行
-删除的这一行
:::数学公式 KaTeX
:::katex
\int_{-\infty}^{\infty} e^{-x^2}\,dx = \sqrt{\pi}
:::流程图 Mermaid
:::mermaid
graph LR
A --> B --> C
:::语法错误时保留源码显示。
REST API 文档卡
:::api GET /api/v1/books
接口的总体描述。
=== "参数"
- `page`:页码
- `size`:每页数量
=== "响应"
返回书籍列表。
:::小节内容需比 === "标题" 行多缩进(建议 4 空格)。
五、行内扩展
均可在段落、表格、提示块等任意位置使用;行内代码(反引号)里不生效。
按钮
!btn[按钮文字](https://example.com)第三个参数可选,用 Tailwind 类自定义样式,如 !btn[下载](/file.zip){bg-emerald-600 text-white}。
悬浮提示
!tip[鼠标悬停的词](这里是悬浮显示的说明文字)开关(静态展示)
!switch[开关文字](on)第二个参数 true/on/1/yes 为开启态,否则关闭态。仅作展示,不可交互。
图标
:rocket:
:settings{16,#2563eb}名称为 lucide 图标名;花括号内 尺寸,颜色 可省略(默认 20px、继承文字色)。
GitHub Issue 徽章
修复了 infosphere#123 和 owner/repo#456。单独写 #123 会链接到默认仓库(devlive-community/infosphere)。
六、图片扩展
在标准图片语法基础上,支持标题、尺寸与对齐:
=宽x高:像素尺寸,可只写宽(=800x)或只写高(=x600)- 对齐:
left(左浮动)/right(右浮动)/center(居中),可省略 - 编辑器工具栏/斜杠菜单插入图片会自动上传并生成标准语法
七、编辑器技巧
斜杠命令
在行首或空白后输入 /(或 $.)弹出命令菜单,继续输入可按名称或关键词过滤:
| 命令 | 作用 | 命令 | 作用 |
|---|---|---|---|
| 标题 1–4 | 插入 #~`####` |
折叠面板 | 插入 Accordion 片段 |
| 无序/有序/任务列表 | 行首插入标记 | 步骤 | 插入 Steps 片段 |
| 引用 | 行首插入 > |
子章节目录 | 插入 [children] |
| 代码块 | 插入 ``` 围栏 | 分隔线 | 插入 --- |
| 表格 | 插入表格骨架 | 图片 | 上传图片 |
| 标签页 | 插入 Tabs 片段 | 网页采集 | 抓取网页正文转 Markdown |
| 备注/提示/警告 | 插入 Note/Tip/Warning | 链接 | 插入链接 |
↑ ↓ 选择,Enter/Tab 确认,Esc 关闭。
快捷键
| 快捷键 | 作用 |
|---|---|
Ctrl/⌘ + B |
加粗 |
Ctrl/⌘ + I |
斜体 |
Ctrl/⌘ + K |
插入链接 |
Ctrl/⌘ + F |
查找 / 替换(选中文本自动填入查找框) |
Ctrl/⌘ + Shift + D |
复制当前行 / 选中的行 |
Alt + ↑ / Alt + ↓ |
上移 / 下移整行 |
Tab / Shift+Tab |
缩进 / 反缩进(列表与多行选区) |
其他
- 分栏预览:实时预览(约 0.3s 防抖),编辑区与预览区滚动同步
- 专注模式:隐藏侧栏沉浸写作,
Esc退出 - 章节修改会自动保存草稿,意外退出可恢复
评论
登录后参与评论
InfoSphere