1. 程式人生 > >README.md檔案 github Markdown語言詳解 md檔案用法和說明

README.md檔案 github Markdown語言詳解 md檔案用法和說明

本人使用.md文件完全為了記錄日常的編譯和工作中遇到的問題,需要用到的功能大概就是常用的語法,強調,引用,程式碼,連結等。對於圖片的插入需求不高,因此本文主要介紹一些語法特點,最後涉及一點可能用到的其他功能。

000-->功能函式詳細條目:

區塊元素

段落和換行

一個 Markdown 段落是由一個或多個連續的文字行組成,它的前後要有一個以上的空行(空行的定義是顯示上看起來像是空的,便會被視為空行。比方說,若某一行只包含空格和製表符,則該行也會被視為空行)。普通段落不該用空格或製表符來縮排。

「由一個或多個連續的文字行組成」這句話其實暗示了 Markdown 允許段落內的強迫換行(插入換行符),這個特性和其他大部分的 text-to-HTML 格式不一樣(包括 Movable Type 的「Convert Line Breaks」選項),其它的格式會把每個換行符都轉成 <br />

 標籤。

如果你確實想要依賴 Markdown 來插入 <br /> 標籤的話,在插入處先按入兩個以上的空格然後回車。

的確,需要多費點事(多加空格)來產生 <br /> ,但是簡單地「每個換行都轉換為 <br />」的方法在 Markdown 中並不適合, Markdown 中 email 式的 區塊引用 和多段落的 列表 在使用換行來排版的時候,不但更好用,還更方便閱讀。

Markdown 支援兩種標題的語法,類 Setext 和類 atx 形式。

類 Setext 形式是用底線的形式,利用 = (最高階標題)和 - (第二階標題),例如:

This is an H1
=============

This is an H2
-------------

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

類 Atx 形式則是在行首插入 1 到 6 個 # ,對應到標題 1 到 6 階,例如:

# 這是 H1

## 這是 H2

###### 這是 H6

你可以選擇性地「閉合」類 atx 樣式的標題,這純粹只是美觀用的,若是覺得這樣看起來比較舒適,你就可以在行尾加上 #,而行尾的# 數量也不用和開頭一樣(行首的井字元數量決定標題的階數):

# 這是 H1 #

## 這是 H2 ##

### 這是 H3 ######

區塊引用 Blockquotes

Markdown 標記區塊引用是使用類似 email 中用 > 的引用方式。如果你還熟悉在 email 信件中的引言部分,你就知道怎麼在 Markdown 檔案中建立一個區塊引用,那會看起來像是你自己先斷好行,然後在每行的最前面加上 > :

> 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 也允許你偷懶只在整個段落的第一行最前面加上 > :

> 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.   這是第一行列表項。
> 2.   這是第二行列表項。
> 
> 給出一些例子程式碼:
> 
>     return shell_exec("echo $input | $markdown_script");

任何像樣的文字編輯器都能輕鬆地建立 email 型的引用。例如在 BBEdit 中,你可以選取文字後然後從選單中選擇增加引用階層

列表

Markdown 支援有序列表和無序列表。

無序列表使用星號、加號或是減號作為列表標記:

*   Red
*   Green
*   Blue

等同於:

+   Red
+   Green
+   Blue

也等同於:

-   Red
-   Green
-   Blue

有序列表則使用數字接著一個英文句點:

1.  Bird
2.  McHale
3.  Parish

很重要的一點是,你在列表標記上使用的數字並不會影響輸出的 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. 開始,因為 Markdown 未來可能會支援有序列表的 start 屬性。

列表專案標記通常是放在最左邊,但是其實也可以縮排,最多 3 個空格,專案標記後面則一定要接著至少一個空格或製表符。

要讓列表看起來更漂亮,你可以把內容用固定的縮排整理好:

*   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 個製表符:

*   一列表項包含一個列表區塊:

        <程式碼寫在這>

當然,專案列表很可能會不小心產生,像是下面這樣的寫法:

1986. What a great season.

換句話說,也就是在行首出現數字-句點-空白,要避免這樣的狀況,你可以在句點前面加上反斜槓。

1986\. What a great season.

程式碼區塊

和程式相關的寫作或是標籤語言原始碼通常會有已經排版好的程式碼區塊,通常這些區塊我們並不希望它以一般段落檔案的方式去排版,而是照原來的樣子顯示,Markdown 會用 <pre> 和 <code> 標籤來把程式碼區塊包起來。

要在 Markdown 中建立程式碼區塊很簡單,只要簡單地縮排 4 個空格或是 1 個製表符就可以,例如,下面的輸入:

這是一個普通段落:

    這是一個程式碼區塊。

Markdown 會轉換成:

<p>這是一個普通段落:</p>

<pre><code>這是一個程式碼區塊。
</code></pre>

這個每行一階的縮排(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>

一個程式碼區塊會一直持續到沒有縮排的那一行(或是檔案結尾)。

在程式碼區塊裡面, & 、 < 和 > 會自動轉成 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>

程式碼區塊中,一般的 Markdown 語法不會被轉換,像是星號便只是星號,這表示你可以很容易地以 Markdown 語法撰寫 Markdown 語法相關的檔案。

分隔線

你可以在一行中用三個以上的星號、減號、底線來建立一個分隔線,行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線:

* * *

***

*****

- - -

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

區段元素

Markdown 支援兩種形式的連結語法: 行內式參考式兩種形式。

不管是哪一種,連結文字都是用 [方括號] 來標記。

要建立一個行內式的連結,只要在方塊括號後面緊接著圓括號並插入網址連結即可,如果你還想要加上鍊接的 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.

參考式的連結是在連結文字的括號後面再接上另一個方括號,而在第二個方括號裡面要填入用以辨識連結的標記:

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

你也可以選擇性地在兩個方括號中間加上一個空格:

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

接著,在檔案的任意處,你可以把這個標記的連結內容定義出來:

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

連結內容定義的形式為:

  • 方括號(前面可以選擇性地加上至多三個空格來縮排),裡面輸入連結文字
  • 接著一個冒號
  • 接著一個以上的空格或製表符
  • 接著連結的網址
  • 選擇性地接著 title 內容,可以用單引號、雙引號或是括弧包著

下面這三種連結的定義都是相同:

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

請注意:有一個已知的問題是 Markdown.pl 1.0.1 會忽略單引號包起來的連結 title。

連結網址也可以用尖括號包起來:

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

你也可以把 title 屬性放到下一行,也可以加一些縮排,若網址太長的話,這樣會比較好看:

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

網址定義只有在產生連結的時候用到,並不會直接出現在檔案之中。

連結辨別標籤可以有字母、數字、空白和標點符號,但是並區分大小寫,因此下面兩個連結是一樣的:

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

隱式連結標記功能讓你可以省略指定連結標記,這種情形下,連結標記會視為等同於連結文字,要用隱式連結標記只要在連結文字後面加上一個空的方括號,如果你要讓 "Google" 連結到 google.com,你可以簡化成:

[Google][]

然後定義連結內容:

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

由於連結文字可能包含空白,所以這種簡化型的標記內也許包含多個單詞:

Visit [Daring Fireball][] for more information.

然後接著定義連結:

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

連結的定義可以放在檔案中的任何一個地方,我比較偏好直接放在連結出現段落的後面,你也可以把它放在檔案最後面,就像是註解一樣。

下面是一個參考式連結的範例:

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>

下面是用行內式寫的同樣一段內容的 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").

參考式的連結其實重點不在於它比較好寫,而是它比較好讀,比較一下上面的範例,使用參考式的文章本身只有 81 個字元,但是用行內形式的卻會增加到 176 個字元,如果是用純 HTML 格式來寫,會有 234 個字元,在 HTML 格式中,標籤比文字還要多。

使用 Markdown 的參考式連結,可以讓檔案更像是瀏覽器最後產生的結果,讓你可以把一些標記相關的元資料移到段落文字之外,你就可以增加連結而不讓文章的閱讀感覺被打斷。

強調

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>

你可以隨便用你喜歡的樣式,唯一的限制是,你用什麼符號開啟標籤,就要用什麼符號結束。

強調也可以直接插在文字中間:

un*frigging*believable

但是如果你的 * 和 _ 兩邊都有空白的話,它們就只會被當成普通的符號

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

\*this text is surrounded by literal asterisks\*

程式碼

如果要標記一小段行內程式碼,你可以用反引號把它包起來(`),例如:

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>

程式碼區段的起始和結束端都可以放入一個空白,起始端後面一個,結束端前面一個,這樣你就可以在區段的一開始就插入反引號:

A single backtick in a code span: `` ` ``

A backtick-delimited string in a code span: `` `foo` ``

會產生:

<p>A single backtick in a code span: <code>`</code></p>

<p>A backtick-delimited string in a code span: <code>`foo`</code></p>

在程式碼區段內,& 和尖括號會被自動地轉成 HTML 實體,這使得插入 HTML 原始碼變得很容易,Markdown 會把下面這段:

            
           

相關推薦

README.md檔案 github Markdown語言 md檔案用法說明

本人使用.md文件完全為了記錄日常的編譯和工作中遇到的問題,需要用到的功能大概就是常用的語法,強調,引用,程式碼,連結等。對於圖片的插入需求不高,因此本文主要介紹一些語法特點,最後涉及一點可能用到的其

原來Github上的README.md檔案這麼有意思——Markdown語言

轉自 http://blog.csdn.net/zhaokaiqiang1992/article/details/41349819 之前一直在使用github,也在上面分享了不少的專案和Demo,每次建立新專案的時候,使用的都是預設的README.md檔案,也不曾對

轉載-【原來Github上的README.md檔案這麼有意思——Markdown語言

    之前一直在使用github,也在上面分享了不少的專案和Demo,每次建立新專案的時候,使用的都是預設的README.md檔案,也不曾對這個檔案有過什麼瞭解。但是在看到別人寫的專案的README.md裡面竟然有圖片、連結什麼的,就感到很好奇,這效果是什麼加上去的?於是便

轉 原來Github上的README.md檔案這麼有意思——Markdown語言

轉自 http://blog.csdn.NET/zhaokaiqiang1992/article/details/41349819 之前一直在使用github,也在上面分享了不少的專案和Demo,每次建立新專案的時候,使用的都是預設的README.md檔案,也不曾對這

Markdown語言

    之前一直在使用github,也在上面分享了不少的專案和Demo,每次建立新專案的時候,使用的都是預設的README.md檔案,也不曾對這個檔案有過什麼瞭解。但是在看到別人寫的專案的README.md裡面竟然有圖片、連結什麼的,就感到很好奇,這效果是什麼加上去的?於

C語言檔案讀寫函式

1.    首先要理解幾個概念:  檔案: 按一定規則儲存在磁碟上的資料集合。  檔名: 能唯一標識某個磁碟檔案的字串。形式: 碟符:/ 路徑 / 檔名.副檔名  文字檔案:: 資料以其數字字元的ASCII碼形式、一個位元組一個位元組地儲存在磁碟上。  二進位制檔案:資料以二進位制形式在儲存在磁碟上。  裝置

github的應用

GitHubGitHub是版本控制和協作的代碼托管平臺。公共代碼托管平臺的使用方法:(前提是要到官網上註冊一個用戶,完後建一個倉庫)第一步:生成秘鑰:ssh-keygen -t rsa -b 2048 -C "[email protected]"第二步:查看秘鑰:cat /root/.ssh

基於Github搭建SrpingCloudConfig

創建 pass end stat IE 小夥伴 des 版本問題 serve 最近在看SpringCloud,為了幫助自己學習和記憶,所以寫下這篇文章。 從SpringCloud官方文檔上看SpringCloudConfig其實為我們提供配置外部化的一個服務,可以理解成就是

優雅的實現接口轉換——適配器模式.md

adaptee 測試 oid 相對 設計 情況下 之間 testcase over 1.前言 插頭轉換器我們應該都用過。當我們要使用二插頭的電器而身邊只有3孔的插座時,一個插頭轉換器就能解決插頭和插座不匹配的問題。如下圖所示 插頭轉換器其實只做了一件事,就是把原本不能使用

使用vs code編寫Markdown文檔以及markdown語法

技術 代碼塊 想要 空行 圖片 action show div 語言 目錄 首先安裝vscode工具,下載地址如下: https://code.visualstudio.com/ 在vs code的擴展中安裝: Markdown Preview Enhanced 這款

struts2 配置檔案中各個項

<action   name= "Login_* "   method= "{1} "   class= "mailreader2.Login "> 中Login_*帶*是什麼意思?method= "{1} "帶{}這個是什麼意

python模組匯入import.md

一.什麼是模組 模組就好比是工具包,要想使用這個工具包中的工具(就好比函式),就需要匯入這個 模組。 模組的本質就是一個.py檔案,裡面包含已經封裝好的類、方法等。模組匯入也即是使用這個py檔案中的變數、方法。 程式碼執行到模組匯入位置時

FastDFS的配置、部署與API使用解讀(8)FastDFS多種檔案上傳介面

《Poechant的FastDFS的配置、部署與API使用教程》 FastDFS的配置、部署與API使用解讀——(1)入門使用教程 FastDFS的配置、部署與API使用解讀——(2)Java API:根據InputStream、檔名、檔案長度上傳檔案 FastDFS的配置、部署與API

Hibernate ---核心配置檔案(Hibernate.cfg.xml)

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE hibernate-configuration PUBLIC     "-//Hibernate/Hibernate Configuration DTD

smali檔案

詳解smali檔案 上面我們介紹了Dalvik的相關指令,下面我們則來認識一下smali檔案.儘管我們使用java來寫Android應用,但是Dalvik並不直接載入.class檔案,而是通過dx工具將.class檔案優化成.dex檔案,然後交由Dalvik載入.這樣說來,我們無法通

Go語言

       Go(The Google Programming Language)語言是谷歌2009年釋出的第二款開源程式語言。Go語言專門針對多處理器系統應用程式的程式設計進行了優化,使用Go編譯的程式可以媲美C或C++程式碼的速度,而且更加安全、支援並行

Mybatis的mapper檔案中trim標籤

0、背景 parameterType引數型別student是別名,裡面的欄位有id,name,age,sex被封裝成bean物件,跟資料庫中student表中欄位一一對應,以下案例只為一個SQL語句。(初入SSM坑,請多多指教) update student set name='

GitHub使用教程——官網操作指南(翻譯)

GitHub使用指南 原文地址:GitHub官網 示例專案:Hello World 十分鐘輕鬆教學 在學習計算機語言程式設計的過程中建立Hello World 專案是一個歷史悠久的傳統。當你接觸一門新事物的時候可以用它來做一個簡單的練習。讓我們開始使用github吧! 通過本文,

檔案系統及Busybox之一

轉自 https://blog.csdn.net/chenlong12580/article/details/8761108   目錄 1.根檔案系統簡介...2 2.Busybox簡介...2 2.1Busybox簡介...2 2.2Busybox目錄結

Linux Samba服務主配檔案smb.conf中文

從網上找到描述比較詳細的smb.conf中文解釋: 服務名:smb 配置目錄:/etc/sabma/ 主配置檔案:/etc/sabma/smb.conf #============================== Global Settings ==========