跳转至

格式

DocsForge 扩展了标准 Markdown,提供了额外的内联格式选项,用于强调、技术符号和特殊字符。


高亮

使用 ==高亮== 来强调文本:

这是==高亮文本==,用于强调。

这是==高亮文本==,用于强调。

使用高亮来吸引对段落中关键术语、警告或重要提示的注意。


下标

使用 ~下标~ 来表示化学公式和数学符号:

H~2~O 是水的化学式。

CO~2~ 排放是一个主要问题。

E = mc~2~ 是爱因斯坦著名的方程。

H2O 是水的化学式。

CO2 排放是一个主要问题。

E = mc2 是爱因斯坦著名的方程。


上标

使用 ^上标^ 来表示指数和序数词:

圆的面积是 πr^2^。

x^2^ + y^2^ = z^2^

1^st^、2^nd^、3^rd^

圆的面积是 πr2

x2 + y2 = z2

1st、2nd、3rd


插入和删除文本

使用 ++插入++~~删除~~ 来跟踪更改:

这是 ++新++ 文本,这是 ~~旧~~ 文本。

价格是 ~~$50~~ ++$45++。

这是 ++新++ 文本,这是 文本。

价格是 ~~\(50~~ ++\)45++。

类 diff 语法

这对于在文档、变更日志或迁移指南中展示更改非常有用。


键盘按键

使用 ++按键++ 语法表示键盘快捷键:

按 ++ctrl+alt+delete++ 重启。

按 ++cmd+shift+3++ 截屏。

按 ++ctrl+s++ 保存。

按 ++enter++ 确认。

Ctrl+Alt+Del 重启。

Cmd+Shift+3 截屏。

Ctrl+S 保存。

Enter 确认。

组合键

语法渲染为
++ctrl+c++Ctrl+C
++ctrl+v++Ctrl+V
++ctrl+z++Ctrl+Z
++cmd+tab++Cmd+Tab
++alt+f4++Alt+F4
++shift+delete++Shift+Del
++enter++Enter
++escape++Esc
++space++Space

Mark(高亮的别名)

使用 ==标记== 文本(与高亮相同):

==重要==:仔细阅读本节。

重要:仔细阅读本节。


Critic 标记

使用 Critic 标记跟踪草稿中的更改:

这是 删除 文本,这是 插入 文本。

这是 更改改为这样

这是 删除 文本,这是 插入 文本。

这是 更改改为这样

Critic 标记扩展

需要启用 pymdownx.critic 扩展。DocsForge 默认已启用。


智能符号

轻松输入常见符号:

输入输出输入输出
(c)©(tm)
(r)®1/2½
1/4¼3/4¾
+-±-->
<--<->
==><==
<=>...
-----
(c) (tm) (r) 1/2 1/4 +- --> <-- ==> <== ...

© ™ ® ½ ¼ +- → ← > < ...


HTML 实体

直接在 Markdown 中使用任何 HTML 实体:

&copy; &trade; &reg; &mdash; &ndash; &hellip; &larr; &rarr; &uarr; &darr;

© ™ ® — – … ← → ↑ ↓


自定义 CSS 类

将 CSS 类应用于内联元素:

[带类的文本]{: .custom-class }

[红色文本]{: .red }

[大号文本]{: .lg }

需要在自定义样式表中定义这些 CSS 类。


组合格式

混合多种格式样式:

**粗体且==高亮==的文本**

*斜体且~下标~的文本*

`带^上标^的代码`

[带**粗体**文本的链接](https://example.com)

粗体且==高亮==的文本

斜体且下标的文本

带^上标^的代码

粗体文本的链接


数学符号

对于复杂数学公式,使用内置的 KaTeX 支持:

$$
E = mc^2
$$

$$
\sum_{i=1}^{n} x_i = x_1 + x_2 + \cdots + x_n
$$
\[ E = mc^2 \]
\[ \sum_{i=1}^{n} x_i = x_1 + x_2 + \cdots + x_n \]

有关数学块的更多信息,请参阅 代码块


最佳实践

  • 谨慎使用高亮——过度使用会让它失去意义
  • 优先使用 ==高亮== 而不是原生的 <mark> 标签,以保证可移植性
  • 仅将下标/上标用于实际的数学/化学符号,而不是样式设计
  • 键盘按键非常适合教程、快速入门和用户指南
  • Critic 标记对协作编辑和变更日志很有用
  • 不要嵌套过多格式样式——会变得难以阅读
  • 测试特殊字符在搜索结果中的渲染效果

下一步