如何优雅的写MarkDown文件

235 阅读2分钟

如何写MarkDown文件

斜体和粗体

文字两边使用使用 * 和 ** 表示斜体和粗体
*这是斜体*

**这是粗体**

这是斜体

这是粗体

分级标题

在行首加井号表示不同级别的标题 (H1-H6),例如:# H1, ## H2, ### H3,#### H4。使用了分级标题,在文章头部使用[TOC]标记可以自动生成全文目录(部分编辑器支持)。

外链接

使用
[描述](链接地址) 为文字增加外链接。
[百度](https://www.baidu.com)

无序列表

使用 *,+,- 表示无序列表。注意标记后面有空格。
+ 水果
+ 橘子
+ 菠萝
- 香蕉
- 果汁

* 哈哈
* 嘻嘻
  • 水果
  • 橘子
  • 菠萝

有序列表

使用数字和点表示有序列表。注意数字和点后面有空格。
1. 流浪法师
2. 盲僧
3. 锤石
  1. 流浪法师
  2. 盲僧
  3. 锤石

文字引用

使用 > 表示文字引用。
> 野火烧不尽 春风吹又生

野火烧不尽 春风吹又生

行内代码块

使用 your code 表示行内代码块
`#!/bin/bash
  for each in $(kubectl get pods --all-namespaces|grep Evicted|awk '{print $2}');
  do
  kubectl delete pods $each
  done`

#!/bin/bash for each in $(kubectl get pods --all-namespaces|grep Evicted|awk '{print $2}'); do kubectl delete pods $each done

代码块

使用下面标记标识代码块:
```
这是代码块
```
且标记需要紧贴左边,不能有空格
int max(int a,int b){
    if(a>b) return a;
    else return b;
}
也可以使用 四个缩进空格 表示代码块
int a= 18

插入图像

使用
![描述](图片链接地址) 插入图像。
![图片](https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2018/7/16/164a3704e0765eb3~tplv-t2oaga2asx-image.image)

图片

段落和换行

类 Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题)
类 Atx 形式则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶
This is an H1
=============

This is an H2
-------------

This is an H1

This is an H2

分割线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格
为什么
*   *  *
虚拟

为什么


虚拟

上述是一些常用操作,如果有一些其他特殊需求,可参考markdown中文文档

MarkDown中文文档