日本搞逼视频_黄色一级片免费在线观看_色99久久_性明星video另类hd_欧美77_综合在线视频

國內最全IT社區平臺 聯系我們 | 收藏本站
阿里云優惠2
您當前位置:首頁 > php開源 > 綜合技術 > README.md文件 github Markdown語言詳解 md文件用法和說明

README.md文件 github Markdown語言詳解 md文件用法和說明

來源:程序員人生   發布時間:2016-07-13 10:11:29 閱讀次數:3119次

本人使用.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開始就插入<

生活不易,碼農辛苦
如果您覺得本網站對您的學習有所幫助,可以手機掃描二維碼進行捐贈
程序員人生
------分隔線----------------------------
分享到:
------分隔線----------------------------
關閉
程序員人生
主站蜘蛛池模板: 在线免费国产 | 欧美天天视频 | 国内精品久久久久久久97牛牛 | 俺去俺来也在线www色官网 | 成人免费在线播放 | 首页 国产 欧美 日韩 丝袜 | wwww.国产 | 亚洲午夜视频在线观看 | 午夜视频福利网站 | 欧美久久一区二区三区 | 国产一区二区黄色 | 综合精品| 中文字幕人成乱码在线观看 | 国产一级片av | 欧美视频成人 | 国产伦精品一区二区免费 | 日韩一区二区三区免费视频 | 亚洲自拍偷拍第一页 | 久久免费国产视频 | 国产精品影院在线观看 | 日韩视频三区 | 国产一卡二卡在线 | 亚洲欧美一 | 精精国产xxxx视频在线播放 | 日韩一区二区成人 | 国产在线视频一区二区三区 | 国产一区日韩 | 亚洲一区二区三区免费视频 | 炮机高潮痉挛哭叫失禁 | 久久精品网站视频 | 婷婷精品视频 | 男女福利视频 | 国产在线一区二区 | 国产精品麻豆欧美日韩ww | 国产黄大片在线观看 | 欧美日韩在线一区二区三区 | 久久国产福利 | 岛国精品视频在线播放 | 久久久久久免费毛片精品 | 久久99成人 | 亚洲视频1区 |