github markdown语法及使用

历史

Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。它容许人们“使用易读易写的纯文本格式编写文档,而后转换成有效的XHTML(或者HTML)文档”,
自从GitHub流行以来,Markdown做为一种轻量级标记语言就深受程序员的喜好,上手也是很是简单,接下来咱们就来分析一下为何markdown为何能被一贯挑剔的程序员们爱不释手呢?linux

语法

(注:Markdown发展至今衍生出一些细节上有些许差别的版本,这里以GitHub 的Flavored Markdown(一样在标准Markdown语法上有一些修改) 语法为标准讨论,谁叫咱是程序员呢..)
***git


Markdown支持多级标题对应不一样的字体大小,例如:

# Markdown
## Markdown
### Markdown
#### Markdown
##### Markdown
###### Markdown

所对应的显示内容为:程序员

Markdown

Markdown

Markdown

Markdown

Markdown
Markdown

最多能够支持6个,并且须要注意的是,这里的#开头的文字或标题必须另起一行,#和文字中间必须有空格,否则GitHub的README没法识别。
同时,有些爱思考的同窗就会说,要是我用七个#,会不会将前六个#做为字体符号,最后一个在文本中显示呢。例如:github

####### Markdown

而结果是:markdown

Markdown测试

显然,Markdown并无对其进行转化。字体


除了用#标识字体(标题)大小,还有一种方法:

Markdown
=========
Markdown
---------

所对应的显示内容为:spa

Markdown

Markdown


这里的字体只分为两级,大号的字体下一行用"="号隔开,略小一号的字体用"-"(短横线)隔开,"="或"-"的数量最好是三个以上,可是有些版本能够为一个,一般的习惯为与字体等长。code


二、段落和换行


分隔线

在实际的文本显示中,为了使文本更加清晰明了,能够适当地加入一些分隔线对象

***
---

分隔线由或者---表示,通常是三个连续的符号,单行开头,也能够多于三个

换行

换行可使用一个或者多个空行来另起一个段落,注意是一个空行,而不是简单地用回车来另换一行,示例:

第一行

第二行
第三行

所对应的显示内容为:

第一行
第二行第三行

很明显,第二行和第三行连到了一块儿,那若是我就是不喜欢隔一个空行,非要以回车来换行呢,考虑到部分强迫症晚期患者,Markdown有另外一种换行的方法:
在上一行的行尾添加两个空格,而后以回车来换行,建议用空行换行
***

插入文本引用

若是我须要将一段文本与正文文本相区分,好比示例,引用文章之类的,怎么作呢?

答案是先换行(隔一个或者多个空行),而后新行以tab键开头,键入文本,示例:

正文

    引用文本示例

所对应的显示内容为:

正文

引用文本示例。

列表

无序列表

无序列表k而已使用* + -来标识,注意在字符以后要添加一个空格,示例:

* Markdown1
+ Markdown2
- Markdown3

所对应的显示内容为:

  • Markdown1
  • Markdown2
  • Markdown3

结果显示,这三种符号是能够交叉使用的


有序列表

有序列表须要添加一个相应的'数字'+'.'+'空格'来标识,示例:

1. Markdown1   
2. Markdown2  
3. Markdown3

所对应的显示内容为:

  1. Markdown1
  2. Markdown2
  3. Markdown3

代码

如何把代码贴上去呢?很简单,将代码用两个`包含起来,这个符号不是单引号,而是反引号,键盘左上角那个

`print "hello world" `

所对应的显示内容为

print "hello world"

同时也能够用上面提到的引用文本的方法来贴代码


连接

添加连接的方法为:

[博客](https://www.cnblogs.com/downey-blog/)

所对应的显示内容为:

博客

,点击高亮字体便可进入相应连接


设置跳转

在写文档时,常常会须要在某段文本上设置连接,跳转到另外一段文本中,最多见的是注脚,对于这些注脚,并不方便写在正文中,可是写在文档末尾又没头没尾的,咱们就能够设置一个链接跳转。它的语法是这样的:
在须要跳转的文本处添加:

[跳转到末尾](#jump1)

在跳转目的地添加:

<span id="jump1">测试跳转的文本</span>

所对应的效果为:跳转到末尾

注意[]中包含显示的说明文本,而(#jump1)至关于定义一个匹配对象。

在跳转目的地则是XXX的格式,jump1对应上述的匹配对象,而XXX是须要添加的文本。

插入图片

插入图片的方法与插入连接相比仅仅在前面多了一个 "!",即:

![pic](https://raw.githubusercontent.com/linux-downey/bloc_test/master/picture/Makedown/Makedown.png)

所对应的显示内容为:

pic

值得注意的是,目前还并无一种兼容性比较好的方法将图片内嵌到文本中,通常的作法是在文本内引用图片的连接,可是在这种作法下,若是图片资源一旦迁移,将会额外增长修改为本


修改图片大小

若是要修改图片大小,可使用HTML的处理方式来插入图片,并设置固定大小

<img src="https://raw.githubusercontent.com/linux-downey/bloc_test/master/picture/Makedown/Makedown.png" width=100 height=60 />

所对应的显示内容为:

同时,也能够按照比例来设置图片大小

<img src="https://raw.githubusercontent.com/linux-downey/bloc_test/master/picture/Makedown/Makedown.png" width="%50" height="%50" />

所对应的显示内容为:


测试跳转的文本


好了,关于markdown的基本语法和使用介绍就到此为止啦,若是朋友们对于这个有什么疑问或者发现有文章中有什么错误,欢迎留言

原创博客,转载请注明出处!

祝各位早日实现项目丛中过,bug不沾身. (完)

相关文章
相关标签/搜索