1. 程式人生 > >Markdown入門指南

Markdown入門指南

很多 註釋 main xhtml 復雜 -c 劃線 外行 創建表

目錄

  • 導語
  • 一、認識Markdown
    • 使用Markdown的優點
  • 二、Markdown 語法
    • 標題
    • 列表
    • 引用
    • 圖片與鏈接
    • 粗體與斜體
    • 表格
    • 代碼框
    • 其它
      • 分割線
      • 索引超鏈
      • 註釋
      •  轉義字符
      • 段落縮進(空格)
      • 字體、字號、顏色

導語

Markdown 是一種輕量級的「標記語言」,它的優點很多,目前也被越來越多的寫作愛好者,撰稿者廣泛使用。看到這裏請不要被「標記」、「語言」所迷惑,Markdown 的語法十分簡單。常用的標記符號也不超過十個,這種相對於更為復雜的 HTML 標記語言來說,Markdown 可謂是十分輕量的,學習成本也不需要太多,且一旦熟悉這種語法規則,會有一勞永逸的效果。

  • 創始人 John Gruber 的 Markdown 語法說明

  • Markdown 中文版語法說明

一、認識Markdown

在剛才的導語裏提到,Markdown 是一種用來寫作的輕量級「標記語言」,它用簡潔的語法代替排版,而不像一般我們用的字處理軟件 Word 或 Pages 有大量的排版、字體設置。它使我們專心於碼字,用「標記」語法,來代替常見的排版格式。例如此文從內容到格式,甚至插圖,鍵盤就可以通通搞定了。目前來看,支持 Markdown 語法的編輯器有很多,包括很多網站(例如簡書)也支持了 Markdown 的文字錄入。Markdown 從寫作到完成,導出格式隨心所欲,你可以導出 HTML 格式的文件用來網站發布,也可以十分方便的導出 PDF 格式,這種格式寫出的簡歷更能得到 HR 的好感。甚至可以利用 CloudApp 這種雲服務工具直接上傳至網頁用來分享你的文章,全球最大的輕博客平臺 Tumblr,也支持 Mou 這類 Markdown 工具的直接上傳。

使用Markdown的優點

  • 專註你的文字內容而不是排版樣式,安心寫作
  • 輕松的導出 HTML、PDF 和本身的 .md 文件。
  • 純文本內容,兼容所有的文本編輯器與字處理軟件。
  • 隨時修改你的文章版本,不必像字處理軟件生成若幹文件版本導致混亂。
  • 可讀、直觀、學習成本低。

二、Markdown 語法

標題

標題是每篇文章都需要也是最常用的格式,在 Markdown 中,如果一段文字被定義為標題,只要在這段文字前加 # 號即可。

一級標題: #

二級標題 :##

三級標題: ###

以此類推,總共 級標題,建議在 “ # ” 號後加一個空格,這是最標準的 Markdown 語法。

另一種標題

  大標題
  ===
  小標題
  ---

列表

熟悉 HTML 的同學肯定知道有序列表與無序列表的區別,在 Markdown 下,列表的顯示只需要在文字前加上 -* 即可變為無序列表,有序列表則直接在文字前加 1. 2. 3. 符號要和文字之間加上一個字符的空格。

  - 列表一
  - 列表二
  * 列表三
  * 列表四
  1. 列表五
  2. 列表六

生成樣式:

  • 列表一
  • 列表二
  • 列表三
  • 列表四
  1. 列表五
  2. 列表六

嵌套列表

- + * 可循環使用,但符號之後的空格不能少,符號之前的空格也不能少

  - 嵌套列表1
   + 嵌套列表2
   + 嵌套列表3
    - 嵌套列表4
     * 嵌套列表5
  - 嵌套列表6

生成樣式:

  • 嵌套列表1
    • 嵌套列表2
    • 嵌套列表3
      • 嵌套列表4
        • 嵌套列表5
  • 嵌套列表6

引用

如果你需要引用一小段別外的句子,那麽就要用引用的格式

> 例如這樣
>> 引用中的引用
>>> 很多引用

生成樣式:

例如這樣


例如這樣

引用中的引用

很多引用

只需要在文本前加入 > 這種尖括號(大於號)即可

圖片與鏈接

插入鏈接與插入圖片的語法很像,區別在一個 !

圖片為:![Tooltips](URL)

鏈接為:[Tooltips](URL)

  [百度](http://www.baidu.com "百度一下")

Tooltips可省略

生成樣式:

百度

自動鏈接

  <http://www.baidu.com>
  <[email protected]>

生成樣式:

http://www.baidu.com

[email protected]

粗體與斜體

Markdown 的粗體和斜體也非常簡單,用兩個 * 包含一段文本就是粗體的語法,用一個 * 包含一段文本就是斜體的語法。

例如:

**這裏是粗體** *這裏是斜體*

生成樣式:

這裏是粗體 這裏是斜體

表格

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

這種語法生成的表格如下:

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

表格設置表頭居中

|:--|--:| 其中冒號表示表格需要居中的方向

註:不同平臺的解釋器會有不同影響,比如:--: 有可能也會影響表格

代碼框

單行代碼:使用一個 “`”, 將首尾包圍起來。位置在鍵盤ESC的下面一個鍵
多行代碼:使用三個 ` 將首尾行包圍起來。在第一行後指定編程語言,也可以不指定

需要註意的是:寫代碼框的前一行最好為空白行,否則無法生成相應的樣式

使用 tab 鍵即可縮進。

如:

 ‘這是一行代碼‘
 

 ```這是一段代碼```
 

```java
       public void main(String[] args){
            System.out.println("Hello world!");
       }
```

生成樣式:

這是一行代碼

這是一段代碼

public void main(String[] args){
  System.out.println("Hello world!");
}

另一種段落代碼:每行文字前加4個空格或者1個Tab

val s = "hello Markdown"
println( s )
val s = "hello Markdown"
println( s )

註:在創建表格時不使用空格或者Tab做開關,否則會解析成段落代碼

Markdown支持的語言

名稱 關鍵字
AppleScript applescript
ActionScript 3.0 actionscript3 , as3
Shell bash , shell
ColdFusion coldfusion , cf
C cpp , c
C# c# , c-sharp , csharp
CSS css
Delphi delphi , pascal , pas
diff&patch diff patch
Erlang erl , erlang
Groovy groovy
Java java
JavaFX jfx , javafx
JavaScript js , jscript , javascript
Perl perl , pl , Perl
PHP php
text text , plain
Python py , python
Ruby ruby , rails , ror , rb
SASS&SCSS sass , scss
Scala scala
SQL sql
Visual Basic vb , vbnet
XML xml , xhtml , xslt , html
Objective C objc , obj-c
F# f# f-sharp , fsharp
R r , s , splus
matlab matlab
swift swift
GO go , golang

其它

分割線

在一行中用三個以上的星號(*)、減號(-)、下劃線(_)來建立一個分隔線

除空格外行內不能有其他字符

(除第一個符號的左側最多添加三個空格外)三個相同符號兩側可以添加任意多個空格。

---
___
***

生成樣式:




索引超鏈

索引,1 可以是任意字符

  [百度][1]
  [1]:http://www.baidu.com/

百度

註釋

  <!-- 註釋 -->

 轉義字符

Markdown中的轉義字符為\,轉義的有:

符號 名稱
\ 反斜杠
` 反引號
* 星號
_ 下劃線
{} 大括號
[] 中括號
() 小括號
# 井號
+ 加號
- 減號
. 英文句號
! 感嘆號

段落縮進(空格)

&ensp;或&#8194;
&emsp;或&#8195;
&nbsp;或&#160;
&emsp;

這是一句話?或?這是一句話

這是一句話?或?這是一句話

這是一句話 或 這是一句話

?這是一句話

字體、字號、顏色

  <font face="黑體">我是黑體字</font>
  <font face="微軟雅黑">我是微軟雅黑</font>
  <font face="STCAIYUN">我是華文彩雲</font>
  <font color=#0099ff size=12 face="黑體">黑體</font>
  <font color=#00ffff size=3>null</font>
  <font color=gray size=5>gray</font>

我是黑體字
我是微軟雅黑
我是華文彩雲
黑體
null
gray

使用總結:

  1. Markdown 是一個學習成本低的技術。學會它你可以用它記錄任何數據
  2. Markdown 支持html的標簽,在記錄過程中,如果這些標簽滿足不了你,你也可以使用html
  3. 這些知識點不一定都會使用到,一般只要用到常用的幾個,如果忘記了可以再看看教程。

Markdown入門指南