Markdown - 书写格式

  • 作者:KK

  • 发表日期:2016.03.23


文件后缀

markdown的文件后缀名是md,而文件内容和代码一样,都只是纯文本,不是什么二进制文件,接下来就是这些文本的书写规则了


以下是我经常使用的排版符号,熟用它们都能写出一般的文档排版了

换行

在markdown里,要换行的话必须空多一个空行,像下面这样(请复制下面的演示内容到在线编辑器中进行预览):

第1行内容内容内容

换行后第2行内容内容。..

两行之间要空开1个空行,如果不空开的话则只会显示成1行:

第1行内容内容内容
换行后第2行内容内容。..

#号是标题的意思

1个井号就会生成h1标签,2个就会生成h2,试试下面的:

#h1标签,最大的标题

##h2标题,副标题

这是普通内容普通内容,对比一下大小差距

###h3副标题,这是KK我经常用的标题大小

####h4小标题...那h5你自己尝试啦

-号表示一个项目,整体构成一个列表

前面的简介里演示过,我再重复一遍

关于if语句,你需要知道:

- 判断条件必须写在括号里

- 判断条件可以是表达式也可以是变量和值

- 最终条件的结果必须能转化成true才可以

- 如果判断结果后执行语句只有1条,则可以不用加花括号

而且还支持缩进嵌套喔,这样:

组织结构:

- A部门

	- A1同学,第上一项的下面开始缩进一个tab

	- A2同学
	
- B部门

	- B1同学
	
	- B2同学
	
		- B2的小弟1
	
		- B2的小弟2

- C部门

	- 没同学

--- 分割线,但至少要连续3个-号以上就是一条分割线

第1段说明内容

---

上面有条分割线

----

上面也是分割线,至少写4个就行了,多写无谓

----------------

何苦写那么多呢

`号既有高亮突出显示内容的功能,也有显示代码的功能

它需要在一左一右都加上符号以包住要处理的内容

你好$count = count($this->getUsers($xxxx));`

*号也是突出重点

用左右各1个*号包住内容,会以斜体方式显示文字,以吸引阅读者的注意

而2个星号的话就是加粗,个人基本上全部都是加粗方式的

1个星号是斜体: *我是中国人*,不要欺负我!

2个星号是加粗: **不要乱改配置**!

跟上面的`号一样也是突出重点的样子但其实上面的符号反而是主要用于显示短的代码,星号才是加粗的,可是自己怎么运用没人限制你


嵌入HTML

可以直接写HTML

今天<span style="color:green">天气<span>真好,<span style="color:blue">风和日丽<span>

数字。 有序列表

在行的开头写一个数字,再一个点号,加空格,后面就是内容

大家听好了,本系统的使用要注意4个地方:

1. 不要乱改配置

2. 不要删除。xxx文件

3. 当右下有红色叹号时,要看看是不是有新消息

4. 啊吧啦吧啦咇吧呸!

预览效果就是有缩进显示的,但这这有序列表还有一个特性,当我们要在中间插入一行时,它的顺序可以自动重新排列,其实那些数字并不能限制排列,试下在上面的第3行前面加一行,就是这样:

####大家听好了,本系统的使用要注意4个地方:

1. 不要乱改配置

2. 不要删除。xxx文件

3. 这是新插入的一行,下面会自动变成4

3. 当右下有红色叹号时,要看看是不是有新消息

4. 啊吧啦吧啦咇吧呸!

1. 所以你所有行号写 1. 1. 1....都没人管你,只要是数字就行,这样markdown编译工具会自动排成有序的

嵌入代码

嵌入代码的方式有两种,第一种 ``` 这样连续三个 ` 号里面包的就是代码,例子:

```

alert(123);

printf('fdsfds');

```

而且可以在`号后面指定语言,请参考markdown嵌入代码演示,这里包括了一种以缩进的方式来显示代码的,复制里面的内容去在线编辑器看看吧^-^


超级链接

文章内容有时候要添加一些超级链接,书写格式如下:

[野生程序员](http://www.kkh86.com/it)

但这有个缺点,就是无法新窗口打开,都是本窗口跳转的

一些第三方扩展的markdown会支持新窗口打开,我自己的博客用markdown写的,里面的链接也是用了我自己写的定制代码实现了新窗口

但学习这些并不能通用于所有markdown转换工具,只能针对性


图片

写法和超级链接差不多,只是在链接的格式前加个叹号

![草莓](http://www.kkh86.com/it/markdown/img/img-demo.jpg)

会生成<img alt="草莓" src="http://www.kkh86.com/it/markdown/img/img-demo.jpg"/>

但无法调整大小,而且markdown文件始终只是一个文本文件,图片的二进制数据不方便附带进来混杂在文本中,所以要用图片的话都得写图片地址(当然你混杂base64进来不就随你了)


还有其它少用的一些,比如说表格和引用什么的,你用熟普通的排版后,再去搜一下markdown详细的教程,如果现在一下子学太多怕记不住(本身也没多少),反正这些是我觉得最实用,平时最常用的