Markdown

约 727 个字 27 行代码 2 张图片预计阅读时间 5 分钟

什么是Markdown

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，并最终生成 HTML 格式的文档。

基础语法
标题列表引用
#加空格表示一级标题，共有六级标题
- 无序列表使用-加空格
- 有序列表使用数字加.加空格
>加空格表示引用
文本格式化
强调代码分隔线
- 斜体：*或_包围文本
- 粗体：**或__包围文本
- ~~删除线~~：~~包围文本
- 行内代码：`代码`
- 代码块：```语言名
3个或以上的-表示分隔线

链接语法图片语法

表格任务列表定义列表

| 表头1 | 表头2 | 表头3 |
| ----- | ----- | ----- |
| 内容1 | 内容2 | 内容3 |

- [ ] 未完成任务
- [x] 已完成任务

术语
: 术语的定义

代码高亮

示例代码
def hello():
    print("Hello, World!")

按钮表情符号注释

这是一段带注释的文本 (1)

代码块格式化

添加标题添加行号高亮特定行

Python code

print("Hello, world!")

def hello():
    print("Hello, world!")

def example():
    print("This line is highlighted")
    return "This line too"

代码分组展示

CC++

#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}

#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

文本修改标记
删除和添加高亮和注释
- 删除文本：~~已删除的文本~~
- 添加文本：新添加的文本
- 替换文本：~~旧文本~~新文本
- 高亮文本：重要内容
- 添加注释：这是一条注释
快捷键标记
常用快捷键
- 保存：Ctrl+S
- 复制：Ctrl+C
- 粘贴：Ctrl+V
- 撤销：Ctrl+Z
数据表格

方法描述

GET 获取资源

PUT 更新资源

DELETE 删除资源

信息类

基础信息重要信息

注意

这是一个注意事项

信息

这是一条信息

提示

这是一个提示

警告

这是一个警告

危险

这是一个危险提示

错误

这是一个错误信息
文档类

文档说明特殊说明

摘要

这是一个摘要说明

示例

这是一个示例

引用

这是一段引用

Bug

这是一个bug说明

成功

这是一个成功提示

失败

这是一个失败提示

更多资源