程式設計師寫作的必備技能 Markdown

無銘發表於2017-12-04

作為一位程式設計師,除去 Coding 程式設計的硬技能之外,寫作的軟體能也是需要培養的,而寫作處處離不開 Markdown,比如 GitHub 的 Readme 文件。

雖然 Markdown 的語法並不難,但是還是有很多技巧和規範的,我總結梳理了一下,分享給大家。

大神可以直接繞道了,這是給新手學習用的。

Markdown 是一種可以使用普通文字編輯器編寫的標記語言,通過簡單的標記語法,它可以使普通文字內容具有一定的格式。

為什麼使用 Markdown?

為什麼推崇 Markdown 寫作? 而非 Word 類文件呢?

  • Markdown 是一段純文字,使用任何文字編輯器都可以開啟,而要開啟 Word 文件,必須要先安裝 Office 軟體。
  • Markdown 可以很輕鬆的對文件進行排版,而使用 Word,排版要花費大量的精力。
  • Markdown 可以很輕鬆的轉為 Html、Word、PDF 檔案以及電子書。
  • 現有的大多數媒體平臺都已支援 Markdown。
  • ……

Markdown 的建立的初衷實現「易讀易寫」,為的是可以讓我們更專注於創作,從而提高寫作效率。

有寫作經驗的朋友都應該很清楚,一篇文章如果要傳送到多個媒體上,對於文章的排版是一件非常耗時的事情,而使用 Markdown 的文章排版只需一次即可。

如何使用 Markdown ?

Markdown 的優點說了這麼多,它是否學起來很複雜呢?

其實 Markdown 是一個及其簡單的語法,對於寫作而言,我們在 5 - 10 分鐘就可以輕鬆入門。

區塊引用

引用標記符為>,通常用作標註文章的主旨,名人名言的引用等

這是一個引用

標題

形式則是在行首插入 1 到 6 個 #,對應的是 1 到 6 級標題

# 這是 H1

## 這是 H2

###### 這是 H6複製程式碼

列表

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

無序列表的標記是減號 -

- 無序列表1
- 無序列表2複製程式碼

等同於

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

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

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

強調

兩個 *_ 包起來即可, 特殊強調的文欄位落都會被加粗。

這是一段強調的段落

*_ 兩邊不要有空格,否則它們就只會被當成普通的符號。

連結

只要使用方括號<>包起來, Markdown 就會自動把它轉成連結。

baidu.com/

文字上的超連結是如何實現的呢?使用[連結名稱](連結地址) 標記符號

[這是個百度的連結](http://baidu.com)

等同於

這是個百度的連結

圖片

圖片標記符號![圖片名稱](圖片路徑)

![簡書](https://user-gold-cdn.xitu.io/2017/11/30/1600d3b566694bdb?w=96&h=96&f=png&s=867)

等同於

簡書
簡書

Markdown 插入的圖片必須都是線上訪問的, Markdown 中不能直接指定圖片的高度和寬度。

特殊字元

如果我們在 Markdown 中要插入 >* 等等的特殊字元怎麼辦呢?在這些特殊字元前加上反斜槓/即可。

寫作規範

掌握這麼多語法就可以寫作了嗎?其實還是不夠的,我們還需要掌握一些 Markdown 的寫作規範。

中英文之間需要增加空格

正確:

CCTV 是央視訊道。

錯誤:

CCTV是央視訊道。

中英文、數字之間需要增加空格

正確:

今年雙十一我花費了 1000 元。

錯誤:

今年雙十一我花費了1000元。

數字單位之間應該增加空格

正確:

這個硬碟是 10 TB。

錯誤:

這個硬碟是 10TB。

不要重複使用標點符號

正確:

今年雙十一我居然花費了 1000 元!

錯誤:

今年雙十一我居然花費了 1000 元!!??

專有名詞使用正確的大小寫

正確:

請使用 WeChat 登入。

錯誤:

請使用 wechat 登入。

全形和半形符號

如果你不瞭解全形和半形符號,請檢視全形百度百科

中文段落中使用中文全形標點。

正確:

嗨!你好!

錯誤:

嗨!你好!

英文整句使用半形標點

正確:

I Belive You.

錯誤:

I Belive You。

有研究表表明:打字時不喜歡在中英文之間加空格的人,感情路都會走的很辛苦!所以大家一定要養成寫作規範的好習慣哦!

讓我們一起愉快地使用 Markdown 開始創作吧!

參考文獻

相關文章