1. 程式人生 > >學習筆記:利用markdown寫readme文件 (Udacity學城)

學習筆記:利用markdown寫readme文件 (Udacity學城)

週末逛知乎等資訊平臺的時候,無意間瞭解到Udacity學城有一期關於利用markdown撰寫readme文件的教程,想到CSDN部落格也提供了markdown編輯功能,而自己到現在還不會用,看著自己寫的醜陋的部落格,決定趁此機會學習一下。於是乎,在學習過程中寫了以下總結。

以後可以用markdown寫部落格了,開心~

Markdown 基礎知識

Markdown 是一種輕型標記語言,經常用於 README 的編寫(但是也有用其他語言寫的!)。它非常簡單,大部分語法都很直觀。

但實際上,Markdown 有許多不同的“方言”,就像在口語中一樣。其中每種“方言”都被稱為 Markdown 的“風格(flavor)”。這些方言大致相同,只有細微差別。

課程中講述的是 GitHub 風格的 Markdown

速成教程如下。

設定文字加粗

要將文字設定為粗體,請用兩個星號將其括起。因此,這行程式碼:

Isn’t today a **wonderful** day?

會顯示為:Isn’t today a wonderful day?

這比 HTML 中的 標記更易讀,還能少打好多字元。

設定文字斜體

要將文字設定為斜體,請在文字兩旁新增下劃線。因此,這行程式碼:

And in that moment I thought to myself: _Did I turn off the stove?_

會顯示為:And in that moment I thought to myself: Did I turn off the stove?

與上一個示例相似,這樣的程式碼更接近自然語言,原始文件瀏覽起來非常方便。

碼,還是 不碼?

內聯程式碼標記,用於標註普通文字中的程式碼,為此,你需要在程式碼文字兩旁新增反撇號(`,不是單引號)。因此,這行程式碼:

You should use the `strong` tag.

會顯示為:You should use the strongtag.

這比“You should use the strong tag.”有意義多了。

標題順序

標題更簡單!對於 h1 到 h6 標籤,你只需要在文字前新增 #。Markdown 會根據 # 的數量生成相應的標題()標記。例如:
##This is an h2.
###This is an h3.
會顯示為…
這裡寫圖片描述

HTML 仍然有效

使用 Markdown 時要謹記一點,HTML 在 Markdown 中仍然有效。如果有 Markdown 無法完成的工作,完全可以再用回 HTML。

這裡的問題是,你的工作很可能會變得過於複雜。如果你需要回到純 HTML,那麼很可能有更簡單的格式,就能傳達任何你想要說的內容。

使用 .md 檔案

與 HTML 檔案應使用 .html 副檔名來儲存類似,Markdown 檔案應該使用 .md 副檔名來儲存。

Markdown 本身無法像 HTML 文件一樣在瀏覽器中開啟。如果你要預覽 Markdown 檔案, Dillinger是執行此操作的絕佳線上資源。

列表

無序列表

在符號“-”後加空格使用。
- 無序列表1
- 無序列表2
- 無序列表3

會顯示為:

  • 無序列表1
  • 無序列表2
  • 無序列表3

無序列表

有序列表的使用,在數字及符號“.”後加空格幾個,如下:
1. 有序列表1
2. 有序列表2
3. 有序列表3

會顯示為:

  1. 有序列表1
  2. 有序列表2
  3. 有序列表3

連結和圖片

![這裡寫圖片描述](http://img3.douban.com/mpic/s1108264.jpg)
會顯示為:
!這裡寫圖片描述

程式碼塊引用

在程式碼開頭和結尾加上三個反斜號“`

if p.visualization_dbg==1
    mySubplot(2,1,5,1,im_patch_cf,'FG+BG','gray');
    mySubplot(2,1,5,2,likelihood_map,'obj.likelihood','parula');
    mySubplot(2,1,5,3,response_cf,'CF response','parula');
    mySubplot(2,1,5,4,response_pwp,'center likelihood','parula');
    mySubplot(2,1,5,5,response,'merged response','parula');
    drawnow
end

例項

下面,是一個將html改成markdown標記的例子。

這裡寫圖片描述

這裡寫圖片描述