程序员喜爱的文本文档Markdown格式

Markdown的简单语法

Posted by qin4zhang on June 12, 2019

Markdown的优缺点分析:

  • 优点
    1. 纯文本文件,不会存在排版的效果,只要支持Markdown的语法,哪里都一个效果,简单省心。
    2. 语法规则较富文本简单太多了,前期可能会需要熟悉下语法,之后就如鱼得水。
  • 缺点
    1. 有的编辑器不支持Markdown语法,不过现在主流的编辑器都是支持的,很多可以插件扩展。
    2. 语法嘛,一个新的文本语言总是要花费时间的,有成本考虑。

语法简介

标题

# 一级标题 H1
## 二级标题 H2
### 三级标题 H3
#### 四级标题 H4
##### 五级标题 H5
###### 六级标题 H6

示例:

一级标题 H1

二级标题 H2

三级标题 H3

四级标题 H4

五级标题 H5
六级标题 H6

字体

**这是加粗的文字**
*这是倾斜的文字*`
***这是斜体加粗的文字***
~~这是加删除线的文字~~

示例:

这是加粗的文字 这是倾斜的文字` 这是斜体加粗的文字 这是加删除线的文字


引用

>这是引用的内容1
>>这是引用的内容2
>>>这是引用的内容3
>>>>这是引用的内容4
>>>>>这是引用的内容5

示例:

这是引用的内容1

这是引用的内容2

这是引用的内容3

这是引用的内容4

这是引用的内容5


分割线

---
1111

----

222

***

333

*****

示例:


1111


222


333


444


图片

![图片alt](图片地址 "图片title")

图片alt就是显示在图片下面的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。
title可加可不加

示例:

funny-cat


超链接

[超链接名](超链接地址 "超链接title")
title可加可不加

或者

<a href="超链接地址" target="_blank">超链接名</a>

示例:

有趣的猫


列表

无序列表

- 列表内容
+ 列表内容
* 列表内容

注意:- + * 跟内容之间都要有一个空格

示例:

  • 列表内容
  • 列表内容
  • 列表内容

有序列表

1.列表内容
2.列表内容
3.列表内容

注意:序号跟内容之间要有空格

示例:

1.列表内容 2.列表内容 3.列表内容

表格

|表头|表头|表头|
|---|:---:|---:|
|内容|内容|内容|
|内容|内容|内容|

第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右

示例:

姓名 技能 排行
刘备备 大哥是老大
关羽 二哥
张飞 三弟

代码

`代码内容`

(```)
  代码...
  代码...
  代码...
(```)
注:为了防止转译,前后三个反引号处加了小括号,实际是没有的。
这里只是用来演示,实际中去掉两边小括号即可。

示例:

代码1

代码12
代码13
代码2333

流程图

st=>start: 开始
op=>operation: My Operation
cond=>condition: Yes or No?
e=>end
st->op->cond
cond(yes)->e
cond(no)->op

嵌套使用实例

整个段落引用

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.

引用内引用

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

多种引用

> ## 这是一个标题。
> 
> 1.   这是第一行列表项。
> 2.   这是第二行列表项。
> 
> 给出一些例子代码:
> 
>     return shell_exec("echo $input | $markdown_script");

这是一个标题。

  1. 这是第一行列表项。
  2. 这是第二行列表项。

给出一些例子代码:

return shell_exec("echo $input | $markdown_script");