编辑 MUA Docs 应当使用 Markdown 语言。这是一种轻量级的标记语言,使用纯文本格式的语法。它是在 GitHub 等主要代码仓库中编写文档的推荐语法。
MUA Docs 使用的 Wiki.js 支持完整的 CommonMark 规范 并添加了一些有用的扩展(包括 GitHub 风格的 Markdown 插件)。
你也可以在下面找到有关它们的用法。使用 Ctrl + F 进行用法检索。
这里列出了一些能够让排版看起来稍微好看的要点和格式。
在需要引用的文本前面添加一个 > 符号,后跟一个空格。
> 这是一段例子
> 这还是一段例子
这是一段例子
这还是一段例子
通过在引用块代码之后另起一行并添加类代码,你可以更改引用块的外观。注意这些样式是仅适用于 Wiki.js 的,在其他地方是无法使用的。
is-info
is-success
is-warning
is-danger
> 这是一段例子
> 这还是一段例子
{.is-info}
这是一个默认未设置样式的引用块。
这是一个
{.is-info}
引用块。
这是一个
{.is-success}
引用块。
这是一个
{.is-warning}
引用块。
这是一个
{.is-danger}
引用块。
在文本前后添加 ** 符号。
这样就会 **加粗**
这样就会 加粗
在代码文本前后的专用行添加 ``` 符号。
```
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
默认情况下,代码块将作为普通的预格式化文本呈现。然而,对于编程代码,最好使用语法高亮,以便更容易阅读。要指定代码块中使用的编程语言,只需在开头的三个反引号后面添加语言关键字:
```java
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
请参阅大约 185 种支持的编程语言的 参考列表。
使用标题,并在标题后添加 {.tabset}
类。父标题文本在最终结果中不会显示(所以你写什么都可以,比如这个演示案例中写的就是原神启动)。
注意,你可以使用任何级别的标题,只要子标题比父标题高一级。例如,如果父标题是 ###
(h3),则子标签头必须是 ####
(h4)。所以,父标题的最大级别为 5,子标题为 6。
# 标签 {.tabset}
## 第一个标签
这里的任何内容都会进入第一个标签...
## 第二个标签
这里的任何内容都会进入第二个标签...
## 第三个标签
这里的任何内容都会进入第三个标签...
这里不太好演示实际效果,但这篇演示文档几乎全部都应用了标签功能,你可以直接点进源码查看。
使用语法 :标识符:
查看 表情符号备忘单 以获取所有可用表情。
:apple:
也可以在行内使用 :fire:
也可以在行内使用 。
使用语法 [^1]
来标记主文本中脚注的位置,使用 [^1]: 这是一个脚注
来实际定义脚注。整个页面的最下方也会自动添加脚注的内容。
这句话需要一些脚注[^1]。
[^1]: 我是一个例子。
这句话需要一些脚注[1]。
使用 1 到 6 个 # 符号,后跟一个空格。
# 标题 1
## 标题 2
### 标题 3
#### 标题 4
##### 标题 5
###### 标题 6
在专用行上使用 --- 符号。
这是一段例子
---
这还是一段例子
这是一段例子
这还是一段例子
使用语法 ![图片替代文本](图片来源 "图片标题")
。
图片替代文本 —— 图片无法加载时显示的文本
图片来源 —— 图片的文件路径(可以是本地或者网络地址)
图片标题 —— 用户鼠标悬停时显示
![介绍](/link/to/image.jpg)
也可以放在 ![介绍](/link/to/image.jpg) 一个句子的中间
有时候图片太大,你可能需要调整一下。
只需在图片路径的末尾以以下格式添加尺寸标记:
![图片](/link/to/image.jpg =100x50)
你也可以省略其中一个值以自动保持图片比例:
![图片](/link/to/image.jpg =100x)
![图片](/link/to/image.jpg =x50)
还可以使用其他单位,如 %。
![图片](/link/to/image.jpg =100%x)
在代码前后添加 ` 符号。
我是 `一段` 代码
我是 一段
代码
在文本前后添加 * 符号。
我是 *斜体*
我是 ipsum
在按键文本前添加 <kbd>
并且在结尾添加 </kbd>
。
使用 <kbd>CTRL</kbd> + <kbd>C</kbd> 复制
使用 CTRL + C 复制
使用语法 [链接文本](链接地址)
。
在每行文本前使用 数字,后跟一个 点 符号,再后跟一个空格。
1. 项目一
1. 项目二
1. 项目三
虽然你可以按顺序为每行编号,但使用数字 1 在每行上更简单。最终结果将自动递增。这样,当以后添加或删除一行时,你不需要重新编号每一行。
在文本前后添加 ~ 符号。
我是 ~下标~
我是 下标
在文本前后添加 ^ 符号。
我是 ^上标^
我是 上标
使用语法:
| 标题 A1 | 标题 B1 | 标题 C1 |
|-----------|-----------|-----------|
| 单元格 A2 | 单元格 B2 | 单元格 C2 |
| 单元格 A3 | 单元格 B3 | 单元格 C3 |
...
| 标题 1 | 标题 2 | 标题 3 |
|----------|----------|----------|
| 1 | 4 | 5 |
| 2 | 3 | 6 |
结果为:
标题 1 | 标题 2 | 标题 3 |
---|---|---|
1 | 4 | 5 |
2 | 3 | 6 |
通过在表格后的单独行上添加类 dense
,你可以使表格使用更小的字体和更小的填充。例如:
| 标题 1 | 标题 2 | 标题 3 |
|----------|----------|----------|
| 1 | 4 | 5 |
| 2 | 3 | 6 |
{.dense}
将结果为:
标题 1 | 标题 2 | 标题 3 |
---|---|---|
1 | 4 | 5 |
2 | 3 | 6 |
使用语法 - [ ]
或 - [x]
。
- [x] 已完成的任务项
- [x] 另一个已完成的任务项
- [ ] 未完成的任务项
在每行文本前使用 星号 或 破折号 符号,后跟一个空格。
- 项目一
- 项目二
- 项目三
通过在列表后的专用行添加类,你可以更改列表的外观:
links-list
grid-list
例如:
- 项目一
- 项目二
- 项目三
{.grid-list}
- [项目一 *副标题描述在这里*](https://www.mualliance.cn)
- [项目二 *另一个副标题描述在这里*](https://www.mualliance.cn)
- [项目三 *第三个副标题描述在这里*](https://www.mualliance.cn)
{.links-list}
结果为:
和
注意,这些样式是特定于 Wiki.js 的,在其他应用程序中将回退到标准列表样式。
在文本前后添加 ~~ 符号。
我被 ~~删除~~ 啦
我被 删除 啦
以下内容仅搬运官方 Wiki 和简单翻译,请自行摸索使用方法。
使用语言 mermaid 的代码块。
请参阅 Mermaid 网站 了解语言参考。
```mermaid
sequenceDiagram
Alice ->> Bob: Hello Bob, how are you?
Bob-->>John: How about you John?
Bob--x Alice: I am good thanks!
Bob-x John: I am good thanks!
Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.
Bob-->Alice: Checking with John...
Alice->John: Yes... John, how are you?
```
以下内容仅搬运官方 Wiki 和简单翻译,请自行摸索使用方法。
使用语言 plantuml 的代码块。
请参阅 PlantUML 网站 了解语言参考。
```plantuml
Bob->Alice : hello
```
我是一个例子。 ↩︎