国内最全IT社区平台 联系我们 | 收藏本站
华晨云阿里云优惠2
您当前位置:首页 > php开源 > 综合技术 > README.md文件 github Markdown语言详解 md文件用法和说明

README.md文件 github Markdown语言详解 md文件用法和说明

来源:程序员人生   发布时间:2016-07-13 10:11:29 阅读次数:2876次

本人使用.md文档完全为了记录平常的编译和工作中遇到的问题,需要用到的功能大概就是经常使用的语法,强调,援用,代码,链接等。对图片的插入需求不高,因此本文主要介绍1些语法特点,最后触及1点可能用到的其他功能。


000-->功能函数详细条目:

区块元素

段落和换行

1个 Markdown 段落是由1个或多个连续的文本行组成,它的前后要有1个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某1行只包括空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。

「由1个或多个连续的文本行组成」这句话其实暗示了 Markdown 允许段落内的逼迫换行(插入换行符),这个特性和其他大部份的 text-to-HTML 格式不1样(包括 Movable Type 的「Convert Line Breaks」选项),其它的格式会把每一个换行符都转成 <br /> 标签。

如果你确切想要依赖 Markdown 来插入 <br /> 标签的话,在插入处先按入两个以上的空格然后回车。

的确,需要多费点事(多加空格)来产生 <br /> ,但是简单地「每一个换行都转换为 <br />」的方法在 Markdown 中其实不合适, Markdown 中 email 式的 区块援用 和多段落的 列表 在使用换行来排版的时候,不但更好用,还更方便浏览。

Markdown 支持两种标题的语法,类 Setext 和类 atx 情势。

类 Setext 情势是用底线的情势,利用 = (最高阶标题)和 - (第2阶标题),例如:

This is an H1 ============= This is an H2 -------------

任何数量的 = 和 - 都可以有效果。

类 Atx 情势则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶,例如:

# 这是 H1 ## 这是 H2 ###### 这是 H6

你可以选择性地「闭合」类 atx 样式的标题,这纯洁只是美观用的,若是觉得这样看起来比较舒适,你就能够在行尾加上 #,而行尾的# 数量也不用和开头1样(行首的井字符数量决定标题的阶数):

# 这是 H1 # ## 这是 H2 ## ### 这是 H3 ######

区块援用 Blockquotes

Markdown 标记区块援用是使用类似 email 中用 > 的援用方式。如果你还熟习在 email 信件中的引言部份,你就知道怎样在 Markdown 文件中建立1个区块援用,那会看起来像是你自己先断好行,然后在每行的最前面加上 > :

> 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.

Markdown 也允许你偷懒只在全部段落的第1行最前面加上 > :

> 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.

援用的区块内也能够使用其他的 Markdown 语法,包括标题、列表、代码区块等:

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

任何像样的文本编辑器都能轻松地建立 email 型的援用。例如在 BBEdit 中,你可以选取文字后然后从选单当选择增加援用阶层

列表

Markdown 支持有序列表和无序列表。

无序列表使用星号、加号或是减号作为列表标记:

* Red * Green * Blue

同等于:

+ Red + Green + Blue

也同等于:

- Red - Green - Blue

有序列表则使用数字接着1个英文句点:

1. Bird 2. McHale 3. Parish

很重要的1点是,你在列表标记上使用的数字其实不会影响输出的 HTML 结果,上面的列表所产生的 HTML 标记为:

<ol> <li>Bird</li> <li>McHale</li> <li>Parish</li> </ol>

如果你的列表标记写成:

1. Bird 1. McHale 1. Parish

或乃至是:

3. Bird 1. McHale 8. Parish

你都会得到完全相同的 HTML 输出。重点在于,你可让 Markdown 文件的列表数字和输出的结果相同,或是你懒1点,你可以完全不用在乎数字的正确性。

如果你使用怠惰的写法,建议第1个项目最好还是从 1. 开始,由于 Markdown 未来可能会支持有序列表的 start 属性。

列表项目标记通常是放在最左侧,但是其实也能够缩进,最多 3 个空格,项目标记后面则1定要接着最少1个空格或制表符。

要让列表看起来更漂亮,你可以把内容用固定的缩进整理好:

* 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.

但是如果你懒,那也行:

* 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.

如果列表项目间用空行分开,在输出 HTML 时 Markdown 就会将项目内容用 <p> 标签包起来,举例来讲:

* Bird * Magic

会被转换为:

<ul> <li>Bird</li> <li>Magic</li> </ul>

但是这个:

* Bird * Magic

会被转换为:

<ul> <li><p>Bird</p></li> <li><p>Magic</p></li> </ul>

列表项目可以包括多个段落,每一个项目下的段落都必须缩进 4 个空格或是 1 个制表符:

1. This is a list item 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. 2. Suspendisse id sem consectetuer libero luctus adipiscing.

如果你每行都有缩进,看起来会看好很多,固然,再次地,如果你很怠惰,Markdown 也允许:

* This is a list item with two paragraphs. This is the second paragraph in the list item. You're only required to indent the first line. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. * Another item in the same list.

如果要在列表项目内放进援用,那 > 就需要缩进:

* A list item with a blockquote: > This is a blockquote > inside a list item.

如果要放代码区块的话,该区块就需要缩进两次,也就是 8 个空格或是 2 个制表符:

* 1列表项包括1个列表区块: <代码写在这>

固然,项目列表极可能会不谨慎产生,像是下面这样的写法:

1986. What a great season.

换句话说,也就是在行首出现数字-句点-空白,要避免这样的状态,你可以在句点前面加上反斜杠。

1986\. What a great season.

代码区块

和程序相干的写作或是标签语言原始码通常会有已排版好的代码区块,通常这些区块我们其实不希望它以1般段落文件的方式去排版,而是照原来的模样显示,Markdown 会用 <pre> 和 <code> 标签来把代码区块包起来。

要在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就能够,例如,下面的输入:

这是1个普通段落: 这是1个代码区块。

Markdown 会转换成:

<p>这是1个普通段落:</p> <pre><code>这是1个代码区块。 </code></pre>

这个每行1阶的缩进(4 个空格或是 1 个制表符),都会被移除,例如:

Here is an example of AppleScript: tell application "Foo" beep end tell

会被转换为:

<p>Here is an example of AppleScript:</p> <pre><code>tell application "Foo" beep end tell </code></pre>

1个代码区块会1直延续到没有缩进的那1行(或是文件结尾)。

在代码区块里面, & 、 < 和 > 会自动转成 HTML 实体,这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码,只需要复制贴上,再加上缩进就能够了,剩下的 Markdown 都会帮你处理,例如:

<div class="footer"> &copy; 2004 Foo Corporation </div>

会被转换为:

<pre><code>&lt;div class="footer"&gt; &amp;copy; 2004 Foo Corporation &lt;/div&gt; </code></pre>

代码区块中,1般的 Markdown 语法不会被转换,像是星号便只是星号,这表示你可以很容易地以 Markdown 语法撰写 Markdown 语法相干的文件。

分隔线

你可以在1行中用3个以上的星号、减号、底线来建立1个分隔线,行内不能有其他东西。你也能够在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

* * * *** ***** - - - ---------------------------------------

区段元素

Markdown 支持两种情势的链接语法: 行内式参考式两种情势。

不论是哪种,链接文字都是用 [方括号] 来标记。

要建立1个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接便可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来便可,例如:

This is [an example](http://example.com/ "Title") inline link. [This link](http://example.net/) has no title attribute.

会产生:

<p>This is <a href="http://example.com/" title="Title"> an example</a> inline link.</p> <p><a href="http://example.net/">This link</a> has no title attribute.</p>

如果你是要链接到一样主机的资源,你可使用相对路径:

See my [About](/about/) page for details.

参考式的链接是在链接文字的括号后面再接上另外一个方括号,而在第2个方括号里面要填入用以辨识链接的标记:

This is [an example][id] reference-style link.

你也能够选择性地在两个方括号中间加上1个空格:

This is [an example] [id] reference-style link.

接着,在文件的任意处,你可以把这个标记的链接内容定义出来:

[id]: http://example.com/ "Optional Title Here"

链接内容定义的情势为:

  • 方括号(前面可以选择性地加上最多3个空格来缩进),里面输入链接文字
  • 接着1个冒号
  • 接着1个以上的空格或制表符
  • 接着链接的网址
  • 选择性地接着 title 内容,可以用单引号、双引号或是括弧包着

下面这3种链接的定义都是相同:

[foo]: http://example.com/ "Optional Title Here" [foo]: http://example.com/ 'Optional Title Here' [foo]: http://example.com/ (Optional Title Here)

请注意:有1个已知的问题是 Markdown.pl 1.0.1 会疏忽单引号包起来的链接 title。

链接网址也能够用尖括号包起来:

[id]: <http://example.com/> "Optional Title Here"

你也能够把 title 属性放到下1行,也能够加1些缩进,若网址太长的话,这样会比较好看:

[id]: http://example.com/longish/path/to/resource/here "Optional Title Here"

网址定义只有在产生链接的时候用到,其实不会直接出现在文件当中。

链接辨别标签可以有字母、数字、空白和标点符号,但是并辨别大小写,因此下面两个链接是1样的:

[link text][a] [link text][A]

隐式链接标记功能让你可以省略指定链接标记,这类情形下,链接标记会视为同等于链接文字,要用隐式链接标记只要在链接文字后面加上1个空的方括号,如果你要让 "Google" 链接到 google.com,你可以简化成:

[Google][]

然后定义链接内容:

[Google]: http://google.com/

由于链接文字可能包括空白,所以这类简化型的标记内或许包括多个单词:

Visit [Daring Fireball][] for more information.

然后接着定义链接:

[Daring Fireball]: http://daringfireball.net/

链接的定义可以放在文件中的任何1个地方,我比较偏好直接放在链接出现段落的后面,你也能够把它放在文件最后面,就像是注解1样。

下面是1个参考式链接的范例:

I get 10 times more traffic from [Google] [1] than from [Yahoo] [2] or [MSN] [3]. [1]: http://google.com/ "Google" [2]: http://search.yahoo.com/ "Yahoo Search" [3]: http://search.msn.com/ "MSN Search"

如果改成用链接名称的方式写:

I get 10 times more traffic from [Google][] than from [Yahoo][] or [MSN][]. [google]: http://google.com/ "Google" [yahoo]: http://search.yahoo.com/ "Yahoo Search" [msn]: http://search.msn.com/ "MSN Search"

上面两种写法都会产生下面的 HTML。

<p>I get 10 times more traffic from <a href="http://google.com/" title="Google">Google</a> than from <a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>

下面是用行内式写的一样1段内容的 Markdown 文件,提供作为比较之用:

I get 10 times more traffic from [Google](http://google.com/ "Google") than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or [MSN](http://search.msn.com/ "MSN Search").

参考式的链接其实重点不在于它比较好写,而是它比较好读,比较1下上面的范例,使用参考式的文章本身只有 81 个字符,但是用行内情势的却会增加到 176 个字元,如果是用纯 HTML 格式来写,会有 234 个字元,在 HTML 格式中,标签比文本还要多。

使用 Markdown 的参考式链接,可让文件更像是阅读器最后产生的结果,让你可以把1些标记相干的元数据移到段落文字以外,你就能够增加链接而不让文章的浏览感觉被打断。

强调

Markdown 使用星号(*)和底线(_)作为标记强调字词的符号,被 * 或 _ 包围的字词会被转成用 <em> 标签包围,用两个 * 或 _包起来的话,则会被转成 <strong>,例如:

*single asterisks* _single underscores_ **double asterisks** __double underscores__

会转成:

<em>single asterisks</em> <em>single underscores</em> <strong>double asterisks</strong> <strong>double underscores</strong>

你可以随意用你喜欢的样式,唯1的限制是,你用甚么符号开启标签,就要用甚么符号结束。

强调也能够直接插在文字中间:

un*frigging*believable

但是如果你的 * 和 _ 两边都有空白的话,它们就只会被当做普通的符号

如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:

\*this text is surrounded by literal asterisks\*

代码

如果要标记1小段行内代码,你可以用反引号把它包起来(`),例如:

Use the `printf()` function.

会产生:

<p>Use the <code>printf()</code> function.</p>

如果要在代码区段内插入反引号,你可以用多个反引号来开启和结束代码区段:

``There is a literal backtick (`) here.``

这段语法会产生:

<p><code>There is a literal backtick (`) here.</code></p>

代码区段的起始和结束端都可以放入1个空白,起始端后面1个,结束端前面1个,这样你就能够在区段的1开始就插入<

生活不易,码农辛苦
如果您觉得本网站对您的学习有所帮助,可以手机扫描二维码进行捐赠
程序员人生
------分隔线----------------------------
分享到:
------分隔线----------------------------
关闭
程序员人生