markdown菜鳥教程(markdown使用)

在我的工作中,我經常要寫程式碼、寫與程式碼相配套的文件、建立網頁、進行文字恢復專案。我在學校的時候還寫過幾篇正式的論文,也包括寫課堂筆記,幾乎每節課都寫。

我幾乎在我所有的寫作中都使用 Markdown,它對我來說是一個節省時間的好工具。

在這篇文章中,我將分享我使用 Markdown 的體會。你將會了解以下內容:

  • 什麼是 Markdown ?
  • 它是怎麼工作的?
  • Markdown 的基本語法和怎樣使用它們。

什麼是 Markdown ?

假如你是 Markdown 新手,它是一個為網路寫手轉換文字到 HTML 格式的工具。Markdown 文件遵循一種特定的語法,容易閱讀和寫作。它們是純文字,所以能夠通過電腦上的任何文字編輯器來建立。然後這些文件能夠轉換成網頁 —— 而網頁是用一個叫做 HTML 的語言標記建立的。

Markdown 只是一種不必(即使知道怎麼做)寫 HTML 程式碼就能夠建立網頁的方式。實際上,如果你不轉換成 HTML 的話,Markdown 甚至是個對純文字格式化的好方法。有人曾這樣對我描述 Markdown :

它不是所見即所得,而是所見即所意”。

然而,Markdown 不只是一個簡單的格式化體系,它也是一個純文字格式轉化到 HTML 的一個軟體工具。

這就是為什麼語法很重要。如果你想在網頁上起個標題,Markdown 將會基於你標題前面的字元來建立。Markdown 的一些語法示例如截圖所示:

所以我怎樣才能使純文字檔案轉換成 HTML 格式呢?

John Gruber 的 Markdown 是一個執行在命令列上的 Perl 指令碼。也就是說,它可以讀取你建立的 Markdown 文字並用它來構建網頁。

由於有 許多著名的編輯器可以為你做這個轉換,我在這裡儘量避免使用命令列。不僅如此,許多這樣的編輯器會讓你寫下你的文字,並同時向你展示網頁的樣子(稱為渲染)。

Markdown 編輯器總的來說設定了兩幀:左邊部分是你要寫你文字的地方,右邊部分是用 HTML 語言顯示給你格式化後文字的樣子:

當你用它滿意地完成你的寫作,只需儲存 Markdown 檔案即可。就像這樣,之後一旦你需要編輯和修改的時候,你就會用到它。檔案儲存後,你可以用編輯器將 Markdown 文件匯出為 HTML 格式的文件。

編輯器用你的 Markdown 作為參考建立網頁。你的 Markdown 文件在匯出時不會修改,你仍然擁有源文件,同時建立一個獨立的、新的 HTML 文件(網頁),你可以把它放到一個網頁伺服器上。

注意:許多 Markdown 編輯器也可以將你的 Markdown 文件匯出為其他格式,比如.doc.docx.pdf。之後你可以瞭解這些高階設定和你可能需要的額外軟體。

Markdown 基礎語法

為了讓 Markdown 新使用者快速瞭解,我將把這部分內容限制在我最常使用的語法上。我相信這些將是最有幫助的 - 你可以在現在就提高工作效率,同時瞭解更多關於 Markdown 以後能為你做什麼。

寫標題

我經常使用 #字元來表示標題。這裡有六個等級:

# 一級標題 ## 二級標題 ### 三級標題 #### 四級標題 ##### 五級標題 ###### 六級標題

還有一種標題型別,是在文字下使用下劃線。我很少使用這種型別的標題,我只限於使用兩種:一種是使用 =字元表示的雙下劃線,生成H1標題。一種是使用-字元表示的單下劃線,生成H2標題:

一級標題 =============== 二級標題 ---------------

段落

段落被空行隔開(確保段落之間有一個空行)。首行不要縮排。在 Markdown 裡用 Tab鍵或者空格鍵縮排有著不同的目的和作用。

段落是一個文字塊,不應該用空格鍵和 Tab鍵來縮排。它可以有一行或者多行。要結束這一段另起一段,點兩下回車鍵;段落通過一個空行分開。

換行

請記住,對於段落,必須用空行來分隔它們,這要通過按兩次回車鍵來實現。Markdown 對此很嚴格。

Markdown 不支援 “強制插入換行符hard-wrapped” 或者 “固定行長度fixed-line-length” 段落。那就是說,單擊回車鍵一次將不會強制文字換到新的一行。它可能在編輯視窗顯示,但是 HTML 格式下不顯示。

然而,有時你可能需要拆分段落或者換行。Markdown 確實有一種方法可以做到,但是它一開始看起來可能有一點奇怪:換行是通過用兩到多個空格鍵然後點一次回車鍵完成的。

這裡有一個短詩的範例。每行以兩個空格結束。最後一行,由於是這個小節的結束,沒有額外的空格。因為它是這個詩句(段落)的結束,我雙擊回車鍵兩次:

Baa, baa black sheep,   Have you any wool?.   Yes, sir. Yes, sir.   Three bags full.

在一行的最後加兩個空格來建立一個換行,可能需要時間去習慣。

水平線

水平線非常適合將文字拆分為多個部分。

用三個或更多的破折號 -,下劃線_,或者星號*來做水平線,像這樣:

--- *** ___

你甚至可以在字元之間輸入空格:

- - -

在文章和報告中我不經常使用水平線,但是在日記、系統日誌和課堂筆記中對我很有用。

用加粗和斜體來強調文字

當你想讓一個單詞或者短語脫穎而出,引起注意,你可以讓它加粗或者斜體顯示。斜體和加粗文字可以在兩種方式中任選其一。第一種是用星號 *將其包括,第二種是用下劃線_的方式。

使一個單詞或者短語斜體顯示,用一個下劃線或者星號來括住文字。使一個單詞或者短語加粗,使用兩個下劃線或者星號來括住文字:

用星號來顯示 *斜體* 。 用下劃線來顯示 _斜體_ 。 用星號來顯示 **加粗** 。 用下劃線來顯示 __加粗__ 。

記住兩邊使用相同的字元。單詞或短語的一面是星號,另一面是下劃線,將不會生效。相同字元必須在單詞或者短語的兩邊。

塊引用

塊引用被用來直接引用。如果你正在寫部落格,你想重複本傑明•富蘭克林說過的話,你可以使用塊引用。

一個右尖括號被用來指定塊引用:

> 這是塊引用。 >> 如果你想進一步再次塊引用,使用兩個右尖括號。

在 Markdown 中新增超連結

超連結非常酷。在基礎版的 Markdown 語言有三種方式建立超連結,在這裡我只講兩種:普通連線和自動連線。

第三種連結被稱為參考連結,在 Markdown 語言的基礎版和高階版都支援。我想讓你快速入門。你可以在準備好的時候找找參考連結的資料。

普通連結可以讓你連結到各種各樣的網站。網站名稱或者你要使用的短語被放置在中括號 中。真實的連結地址在小括號中。

現在去看看 [Linux 中國](https://linux.cn) 。

自動連線通過用尖括號 括住連結地址。這個連結是一個實際的地址(可以是網址或者電子郵件地址)。拼寫出來的連結被轉換到 HTML 的時候,就變成了有效的連結。

當你想在文字中拼寫出網址時,這很有用:

在 Markdown 中新增圖片

連結圖片幾乎與連結網站一樣。網站連結和圖片連結微小的不同是,圖片連結以感嘆號 !開始。

圖片名稱或者圖片描述放置在中括號 裡。實際連結放置在小括號裡。

你可以像這樣嵌入圖片:

![alternate text](./images/image.jpg)

這兒有一個示例影象連結。這是一個示例連結,沒有這個圖片,但是這是個好例子,顯示了實際連結應該有的樣子:

![a picture of bill](./images/my_photo_of_me.jpg)

列表

製作列表有很多原因。它們可能用來作為代辦事項、大綱中的主題元素、組裝專案中的明細欄等等。列表有兩種主要型別:無序列表和有序列表。

無序列表沒有編號;這些就是我們在許多文件中所看到的列表項。有序列表是有編號的。

要建立一個有序(有編號的)列表,只需在每行用一個數字開始,像這樣:

1. 專案 一。 2. 專案 二。 3. 專案 三。

無序列表沒有編號,但要在列表每個專案的開始使用一個星號 *、一個加號 ,或者一個減號-。我偏向於使用一個星號或者減號,你可以選擇適合你的:

* 專案 一。   專案 二。 - 專案 三。

子專案可以通過縮排被新增到有序和無序列表中,像這樣:

1. 專案 一     1. 子專案 一     2. 子專案 二 2. 專案 二 3. 專案 三

Markdown 語法速查表

這是一個簡短的 Markdown 語法列表為你作為參考,這個列表已經在本小結中介紹。

如果你決定使用 Markdown 作為寫作工具,你會發現 Markdown 會讓寫作變得更加簡單。

下載 PDF 格式的 Markdown 速查表

結語

Markdown 可以做比我描述的更多的事情。我寫作的很大一部分是用我在這裡介紹的 Markdown 語法完成的 - 而這些是我最常使用的專案,即使是在更復雜的專案中。

如果這些看起來太簡單了,那麼說明它真的很容易。Markdown 用來完成簡單的寫作任務,但是你不必完全聽我的。你可以嘗試一下!不必安裝 Markdown 編輯器;你可以線上嘗試。這裡有幾個 優秀的線上 Markdown 編輯器。這裡我喜歡用這三個:

  • John Gruber’s Dingus
  • Editor.md
  • Dillinger

Editor.md和 Dillinger 會讓你看到你的 Markdown 文字作為 HTML 實時渲染的效果。 Dingus 不能實時預覽,但是在參考頁有 Markdown 的語法速查表。

用以上這些線上編輯器嘗試一下文章中的示例。也可以嘗試一下你自己的想法。這將使你在可能致力於學習更多的知識之前習慣於 Markdown。

via: https://itsfoss.com/markdown-guide/

作者:Bill Dyer選題:lujun9972譯者:hwlife校對:wxy

本文由 LCTT原創編譯,Linux中國榮譽推出