跳转至

如何撰写文本文档


文本文档采用 Markdown 格式进行编写。Markdown 是一种轻量级标记语言,语法简洁明了,易于学习和使用,非常适合编写各类文档。本文将通过具体示例,介绍如何使用 Markdown 进行文档撰写。

标题

Markdown 支持六级标题,通过在行首添加 1 - 6 个 # 字符来表示不同级别的标题。

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

效果如下:

文字

Markdown 支持多种文字样式,包括加粗、斜体、删除线和下划线,并且这些样式可以叠加使用。

*文字斜体*
**文字加粗**
***文字斜体加粗***
~~文字删除~~ 
~~**文字加粗删除**~~ 
~~*文字斜体删除*~~ 
<u>文字下划线</u>

效果如下:

分割线

通过连续输入三个及以上的星号 *** 或连字符 --- 可以创建一条分割线。

***
---

效果如下:

代码

使用反引号 ``` 可以标记代码。单行代码使用单个反引号包裹,多行代码块则使用三个反引号包裹。

单行代码:printf("Hello, World!");

多行代码块:

// C 代码示例
#include <stdio.h>
int main() {
    printf("Hello, World!");
    return 0;
}
// Java 代码示例
public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
# Python 代码示例
print("Hello, World!")

效果如下:

表格

表格使用竖线 | 分隔各列,使用连字符 - 定义表头与表格内容的分隔线,并通过冒号 : 设置对齐方式。

|默认格式  | 左对齐 | 居中 | 右对齐 |
| --- | :--- | :---: | ---: |
| 表格内容  | 表格内容 | 表格内容 | 表格内容 |
| 表格内容  | 表格内容 | 表格内容 | 表格内容 |

效果如下:

超链接

通过 [描述文本](链接地址) 的格式可以添加超链接,还可以使用 <链接地址> 直接显示原始 URL。

访问 [观测云](https://console.guance.com/) 获取更多信息。

或者直接打开:<https://console.guance.com/>

图片

使用 ![替代文本](图片链接) 的语法可以在文档中插入图片。

![avatar](https://static.guance.com/dataflux-icon/official/community-code.png" width="60%" >

文档评价

文档内容是否对您有帮助? ×