身為開發者,一定會常常需要使用 Markdown 格式來寫文件。

Markdown 究竟是什麼?它看起來像純文本,有點像 HTML,但兩者都不是?

別擔心,我第一次使用 Markdown 時也是有點困惑。但不久之後,我就習慣了,並意識到它真的很酷。到本文結束時,您將掌握日常使用 Markdown 所需了解的一切。

原文出處:https://dev.to/imluka/the-only-markdown-cheatsheet-you-will-ever-need-ccg


好的,再告訴我一次,什麼是 Markdown,我將在哪裡使用它?

Markdown 是一種輕量級標記語言,可用於格式化純文本文檔。

您可能知道 GitHub 上的每個存儲庫都有自己的 README 文件,其中解釋了存儲庫的用途。每個專案都需要好的文件。 GitHub 的文件是使用 Markdown 編寫的。這正是為什麼有必要知道一些基礎知識。第二個原因是,您最有可能通過吸引人的個人檔案 README 來吸引新的人脈並改善您的網絡。

就是這樣!今天的理論足夠了。來點實用的吧。


段落

通過編寫常規文本,您基本上是在寫一個段落。

段落

標題

有 6 種標題變體。後面跟著文字的“#”符號的數量表示標題的重要性。

標題

重點

修改文本是如此整潔和容易。您可以將文本設為粗體、斜體、刪除線、突出顯示、下標或上標。

強調

區塊引用

想強調文本的重要性?這樣即可。

塊引用

圖片

如果您使用的是 GitHub,最好的方法是簡單地將圖像從您的計算機直接拖放到 README 文件中。您還可以建立對圖像的引用並以這種方式顯示它。

圖片

連結

與圖像類似,連結也可以直接插入或通過建立引用來插入。您可以建立內聯連結和塊連結。

鏈接

程式碼

您可以建立內聯和全塊程式碼片段。您還可以定義您在程式碼段中使用的程式語言。全都是使用反引號。

程式碼

列表

正如您在 HTML 中所做的那樣,Markdown 允許建立有序列表和無序列表。

有序列表

無序列表

您還可以混合兩個列表並建立子列表。

PS. 盡量不要建立超過兩層的列表。這是最佳實踐。

混合列表

也可以建立定義列表(術語 - 定義),您可能不會常使用這個,但有機會用到。

定義列表

表格

顯示排列資料的好方法。使用“|”符號分隔列,使用“:”符號對齊行內容。

表

您還可以通過排除外部“|”符號而不是使您的程式碼結構良好來建立“混亂”的表格。當然,它仍然有效,但是嘿 → 我們應該始終以正確的方式安排事情。

凌亂的表格

任務列表

跟踪已完成的任務和需要完成的任務。

任務列表

腳註

想在文件末尾描述一些東西嗎?使用腳註!

腳註

標題編號

您可以為標題指定 ID,以便無論您身在何處都可以直接跳轉到文件的該部分。

標題 ID

水平線

您可以使用星號、連字符或下劃線(*、-、_)來建立水平線。唯一的規則是您必須至少包含符號的三個字符。

水平線

HTML

您還可以在 Markdown 文件中使用原始 HTML。大多數情況下效果很好,但有時您會遇到一些在使用標準 HTML 時不習慣的差異。使用 CSS 將不起作用。

HTML


以上簡單分享,希望對您有幫助!


共有 0 則留言