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

2021-09-14 04:32:57 字數 2274 閱讀 6304

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

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

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

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

為什麼推崇 markdown 寫作? 而非 word 類文件呢?

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

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

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

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

區塊引用

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

這是乙個引用

標題

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

# 這是 h1

## 這是 h2

###### 這是 h6

列表

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

無序列表的標記是減號-

- 無序列表1

- 無序列表2

等同於

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

有序列表1

有序列表2

有序列表3

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

這是一段強調的段落

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

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

等同於

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

等同於特殊字元

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

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

中英文之間需要增加空格

正確:

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

正確:

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

錯誤:

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

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

正確:

這個硬碟是 10 tb。

錯誤:

這個硬碟是 10tb。

不要重複使用標點符號

正確:

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

錯誤:

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

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

正確:

請使用 wechat 登入。

錯誤:

請使用 wechat 登入。

全形和半形符號

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

正確:

嗨!你好!

錯誤:

嗨!你好!

英文整句使用半形標點

正確:

belive you.

錯誤:

belive you。

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

中文文案排版指北

新手程式設計師必備十項技能

初出茅廬的你帶著仍殘留墨香的畢業證書踏上工作崗位,馬上就被書上沒寫的規則和各種繁雜的日常事務來了個下馬威。這樣的故事實在是司空見慣,程式設計工作也不例外。沒有幾個學生能 100 為自己的第乙份真正的工作做好準備。如果你不想成為其中之一,請學學以下這 10 項無需手把手指導就能學會的基本技能 1 版本...

小白程式設計師必備的十項技能

1 版本控制系統 vcs vcs 也許是計算機課程最大的疏漏。這些課程光記得教如何寫 但卻往往忘記教學生如何去管理 每乙個程式設計師都應該懂得利用 git 或 subversion 有效地建立 repository 倉庫 編輯與提交 進行分支與合併,了解專案工作流。2 學會寫作 身為程式設計師要寫的...

程式設計師公升級必備

程式設計師公升級必備 學過高中物理的人,應該會記得,原子中的電子獲得能量之後,會發生能級躍遷,到達更高的能量狀態。其實任何工種都是一樣的,要跳出自己的水平,到達更高的級別,不是件容易的事。這個跳躍過程總需要一些東西的輔助。誠然,如果要成為乙個好人,那麼只要做好在幼兒園中學到的一切就足夠。如果要成為乙...