如何使用Markdown语言编写文档

目录

  • Markdown 语言简介
  • Markdown基础语法
    • 一、标题
    • 二、段落格式
      • 1. 字体
      • 2. 分隔线
      • 3. 删除线
      • 4. 下划线
      • 5. 脚注
    • 三、列表
      • 1. 无序列表
      • 2. 有序列表
      • 3. 列表嵌套
    • 四、区块引用
    • 五、代码
    • 六、链接
    • 七、图片
    • 八、表格

Markdown 语言简介

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由John Gruber创建。
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF等多种格式的文档。
Markdown 编写的文档后缀为 .md, .markdown。

Markdown基础语法

一、标题

使用#号标记,#号个数即为级数

// 语法:#(空格)(标题名)
# 一级标题
## 二级标题
...

二、段落格式

1. 字体

// 语法
斜体:*斜体文本* 或 _斜体文本_
粗体:**粗体文本** 或 __粗体文本__
粗斜体:***粗斜体文本*** 或 ___粗斜体文本___

输入样例:
*斜体1*	_斜体2_	**粗体1**		__粗体2__		***粗斜体1***		___粗斜体2___

输出效果:斜体1 斜体2 粗体1 粗体2 粗斜体1 粗斜体2

2. 分隔线

// 语法
*** 或 --- 或 ***** 或 -----

输入样例:
***

输出效果:


3. 删除线

// 语法
~~删除线文本~~

输入样例:
~~haha~~

输出效果:haha

4. 下划线

// 语法
带下划线文本

输入样例:
下划线

输出效果:下划线

5. 脚注

// 语法
[^ 要注明的文本名称]
[^ 要注明的文本名称]: 文本内容

输入样例:
[^ zw]
[^ zw]: 脚注

输出效果:^ zw

三、列表

1. 无序列表

// 语法
* 第一项		+ 第一项		- 第一项
* 第二项		+ 第二项		- 第二项
...
输入样例:
* 第一项
* 第二项

输出效果:

  • 第一项
  • 第二项

2. 有序列表

// 语法
1. 第一项
2. 第二项
...
输入样例:
1. 第一项
2. 第二项

输出效果:

  1. 第一项
  2. 第二项

3. 列表嵌套

// 语法
1. 第一项:
(四个空格)- 第一项嵌套的第一个元素
          + 第一项嵌套的第二个元素
2. 第二项

输入样例:
1. 第一项
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素

输出效果:

  1. 第一项
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素

四、区块引用

// 语法
> 最外层
>> 第一层嵌套
>>> 第二层嵌套

输入样例:
> 列表
> 1. 第一项
> 2. 第二项
>>+ 第二项的第一个元素
>>>- 第二项的第一个元素的第一个
* 第一项
    > 开始
    > 结束
    > > 完结
* 第二项

输出效果:

列表

  1. 第一项
  2. 第二项
  • 第二项的第一个元素
  • 第二项的第一个元素的第一个
  • 第一项

    开始
    结束

    完结

  • 第二项

五、代码

// 语法
`函数名` 函数				//标识函数
```代码```				//插入代码

输入样例:
`printf()`函数

```c(指定语言类型,这里我选的C语言)
#include 
int main() {
	return 0;
}```

输出效果:

printf()函数

#include 
int main() {
	return 0;
}

六、链接

// 语法
// 普通链接
[链接名称](链接地址) 或 <链接地址>
// 高级链接
[网址名][网址变量名]
[网址变量名]: 网址

输入样例:
这个一个链接:[百度](https://www.baidu.com) 
这是一个高级链接:[百度][B]
[B]: https://www.baidu.com

输出效果:

这个一个链接:百度 https://www.baidu.com

这是一个高级链接:百度

七、图片

// 语法
![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")

输入样例:
![alt Java](https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fimg-blog.csdnimg.cn%2F20210307174207407.png%3Fx-oss-process%3Dimage%2Fwatermark%2Ctype_ZmFuZ3poZW5naGVpdGk%2Cshadow_10%2Ctext_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ0NzMwODE3%2Csize_16%2Ccolor_FFFFFF%2Ct_70%23pic_center&refer=http%3A%2F%2Fimg-blog.csdnimg.cn&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=auto?sec=1654148314&t=da743815e7833257bfc5ad0ae33d2ea0)

输出效果:
如何使用Markdown语言编写文档_第1张图片

八、表格

// 语法
|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

// 对齐方式
"-:" 设置内容与标题栏居右对齐
":-" 设置内容与标题栏居左对齐
":-:" 设置内容与标题栏居中对齐

输入样例:
| 表头1 | 表头2 |
| ---- | ---- |
| 单元格1 | 单元格2 |

| 左对齐 | 右对齐 | 居中对齐 |
| :----- | -----: | :-----: |
| 单元格1 | 单元格2 | 单元格3 |

输出效果:

表头1 表头2
单元格1 单元格2
左对齐 右对齐 居中对齐
单元格1 单元格2 单元格3

你可能感兴趣的:(Markdown,开发语言,编辑器)