寫做利器——Markdown

一篇讓新手看得懂,懂了就會用的Markdown教程html

什麼是Markdown?

原樣摘抄網絡對於Markdown的介紹沒有任何意義,簡單說來Markdown就是經過極簡的語法編寫漂亮文檔的一種標記語言。特色是兼容性好、學習成本低、便於傳閱。git

爲何要使用Markdown?

  1. 對於程序員來講,使用word編寫文檔對於代碼塊的支持不友好,Markdown能夠直接展現原滋原味的代碼,便於閱讀(以及複製粘貼)。
  2. 一樣對於程序員來講,使用Markdown編寫的文檔能直接用於github。鄙人之前傻乎乎的使用word寫了大篇幅的文檔,後來將代碼託管到github倉庫才發現要將文檔格式轉換真是蛋疼。
  3. Markdown經過工具能夠很容易的轉換爲PDF、word、html等各類格式,其中轉換爲PDF格式是很棒的功能。試想將本身整理好的學習筆記轉爲PDF存檔,利用閒暇時間痛快學習豈不妙哉?並且PDF格式便於傳閱,當在不知道對方系統以及環境的狀況下貿然傳送word文檔,若對方版本不支持,豈不尷尬。
  4. 免費!啓動快!無需安裝!只須要安裝能識別Markdown的編輯器便可,比word純淨清爽不麻煩,最重要的是木有噁心的廣告干擾!
  5. 鄙人平時愛整理學習筆記、bug記錄、項目踩坑經驗等,之前先用記事本簡單記錄以後再用word進行整理,後來身邊大佬都推薦Markdown,發現確實易學上手快,箇中滋味本身體會。
  6. 緊跟時代步伐(隨波逐流),既然你們都在說好用,好歹本身試試唄(手動滑稽)

使用Markdown的正確姿式

工欲善其事必先利其器,若是操做姿式不正確,不只感覺不到工具帶來的便利反而心生不爽影響效率。程序員

開發工具

一些經常使用編程IDE都能直接編寫Markdown,很少囉嗦這裏推薦兩款好用的軟件。github

  • VSCode
    左側編寫右側顯示渲染界面。無需安裝多餘插件,開箱即用。
  • Typora
    簡單逛了下知乎、百度、谷歌後發現Typora叫好聲一片,基於時間成本(實際上是懶)來考慮,就不過多嘗試其餘軟件了,就選它了。
    Typora是編寫即渲染,寫下的Markdown語法直接轉換爲輸出後的效果,且沒有左右分屏更能直觀看到文章效果,Typora還自帶更換主題(默認主體是Github)、導出爲各類格式(PDF、word、html等)、查看大綱等功能。

不過也正是由於Typora的編寫即渲染,有代碼潔癖+強迫症的我習慣先用VSCode進行編寫,同時結合Typora看看效果,改改錯別字啥的,合理利用兩個工具作好本身的事情豈不妙哉。shell

圖牀

圖牀即圖片服務器,要說Markdown惟一不方便的地方大概也是圖片處理了,不能像word那樣直接插入本地圖片。因此咱們使用圖牀讓Markdown如虎添翼。編程

圖牀推薦

這裏推薦七牛雲和Github圖牀,七牛雲有10G免費空間,但須要有本身的備案域名。因此我選擇Github圖牀bash

建立Github圖牀
1. 註冊Github帳號

略...服務器

2. 建立倉庫
  • 在Github首頁點擊New按鈕 markdown

  • 按步驟填寫後完成建立(這裏必定要選擇公共倉庫,由於外部不能訪問到私有倉庫,會致使Markdown中圖片掛掉) 網絡

3. 生成一個Token用於操做GitHub倉庫
  • 點擊右上角頭像,選擇設置按鈕

  • 而後點擊Developer settings

  • 而後點擊Personal access tokens

  • 而後點擊Generate new token

  • 最後填寫token描述,勾選repo

以上,成功生成Token,須要注意的是這串token以後再也不顯示,因此本身保存好。

上傳工具

推薦使用PicGo

下載PicGo

在Github搜索PicGo,找到「下載安裝」模塊,點擊下載應用連接,而後選擇對應的安裝包

圖牀配置

如今就能夠痛快的使用圖牀了,在PicGo裏面上傳以後複製對應連接粘貼到編輯器中便可(注意,若倉庫有重複圖片文件會提示上傳失敗,服務端出錯)

經常使用語法

如下收錄Markdown經常使用語法以及對應代碼,由於Markdown中同一個功能能夠有多種寫法,好比下劃線、星星符號、減號等。着實考慮很周全(麻煩)呢。小聲比比...故本教程挑選了最爲最溫馨寫法。固然這裏有完整的Markdown官網中文教程

換行

句子或段落後敲兩個空格或者使用回車鍵敲一個空行便可換行

標題

「#」個數從1-6分別表示爲1-6級標題,須要注意的是#符號後面要有一個空格

# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題
複製代碼

區塊引用

在每行或者整個段落的最前面加上">"符號

> 就像這樣
複製代碼

區塊引用能夠嵌套

1 我愛你啊 很感謝很想念有你的夏天

2 沒有人說謊啊 可時間會擦掉承諾的話

3 很愛你啊 以沉默以眼淚以正好時光

> 1  
> 我愛你啊 很感謝很想念有你的夏天
>> 2  
> 沒有人說謊啊 可時間會擦掉承諾的話
>>> 3  
> 很愛你啊 以沉默以眼淚以正好時光
複製代碼

引用的區塊內也可使用其餘的 Markdown 語法,包括標題、列表、代碼區塊等:

這是一個標題

  1. 這是第一行列表項
  2. 這是第二行列表項 給出一些例子代碼: return shell_exec("echo $input | $markdown_script");

列表

  1. 無序列表

    星號表示無序列表(星號後面記得跟空格)

*. 無序列表
複製代碼
  1. 有序列表

    數字接着一個英文句點表示有序列表(數字也要跟空格)

1. 有序列表
複製代碼

代碼塊

要在 Markdown 中創建代碼塊很簡單,只要簡單地縮進 4 個空格或是 1 個製表符,但推薦使用 ``` 符號 (連續三個反引號把它包起來),由於文章縮進比較多的話代碼會很亂

if(true){
  console.log("我愛你")
}else{
  console.log("你愛我")
}
複製代碼

若是要標記一小段行內代碼,用一個反引號(`)把它包起來

這是一個 <p id="app">我愛你</p> 例子

這是一個 `<p id="app">我愛你</p>` 例子
複製代碼

分隔線

在一行中用三個連續的減號來創建一個分隔線,行內不能有其餘東西


---
複製代碼

連接

連接文字用 [方括號] 來標記,後面緊接着圓括號並插入網址連接。若是要加上連接的 title 文字(鼠標放在連接文字上的提示語),只需在網址後面用雙引號把 title 文字包起來便可

點我有驚喜

[點我有驚喜](http://www.baidu.com "你懂得")
複製代碼

網址用尖括號包起來,Markdown 就會自動把它轉成連接

www.baidu.com/

<http://www.baidu.com/>
複製代碼

圖片跟文字連接相似,格式爲: ![描述文字](圖片連接)

示例圖片

![示例圖片](https://user-gold-cdn.xitu.io/2019/5/31/16b0ce22f5de1031?w=690&h=388&f=gif&s=71227)
複製代碼

強調

一個星號表示字體傾斜,轉爲 標籤。二個星號表示字體加粗,轉爲 標籤。

我愛你

*我愛你*
複製代碼

我愛你

**我愛你**
複製代碼

總結

建議:github圖牀的文件夾直接命名爲images,上傳後的圖片以日期命名,格式爲(年-月-日-數字從1開始的順序)如18-05-31-1

相關文章
相關標籤/搜索