一、入門基礎(chǔ)
Markdown 是什么?
Markdown 是一種輕量級(jí)標(biāo)記語(yǔ)言,它通過(guò)簡(jiǎn)潔的符號(hào)和語(yǔ)法來(lái)對(duì)文本進(jìn)行格式排版,讓你能專注于內(nèi)容創(chuàng)作,而無(wú)需花費(fèi)大量精力在復(fù)雜的排版操作上。生成的文檔可以輕松轉(zhuǎn)換為 HTML、PDF 等格式,廣泛應(yīng)用于寫作、文檔編輯、博客撰寫、代碼注釋等諸多領(lǐng)域。編輯器選擇
有許多支持 Markdown 的編輯器可供選擇,例如:Typora
:界面簡(jiǎn)潔美觀,實(shí)時(shí)預(yù)覽功能強(qiáng)大,你輸入 Markdown 語(yǔ)法的同時(shí),就能看到排版后的效果,操作流暢,對(duì)新手友好。
VS Code
:作為一款功能強(qiáng)大的代碼編輯器,通過(guò)安裝 Markdown 相關(guān)插件(如 Markdown All in One、Markdown Preview Enhanced 等),可以將其打造成專業(yè)的 Markdown 編輯器,還能結(jié)合代碼編輯功能,方便編寫技術(shù)文檔。
有道云筆記
:不僅支持基本的 Markdown 語(yǔ)法,還依托云存儲(chǔ),方便隨時(shí)隨地記錄和編輯文檔,適合日常筆記記錄與分享。
二、基本語(yǔ)法詳解
標(biāo)題
標(biāo)題是文檔結(jié)構(gòu)的重要標(biāo)識(shí),使用 # 符號(hào)來(lái)表示。一個(gè) # 對(duì)應(yīng)一級(jí)標(biāo)題,是文檔的最高層級(jí),字體最大且通常用于文章主標(biāo)題,如 # 我的精彩游記;兩個(gè) # 即 ## 為二級(jí)標(biāo)題,適用于章節(jié)標(biāo)題,字體稍小,像 ## 旅途中的美食探索;以此類推,### 三級(jí)標(biāo)題用于細(xì)分章節(jié),層級(jí)越低字體越小,幫助構(gòu)建清晰的文檔層次。段落
段落是構(gòu)成文檔的基本單元。在 Markdown 中,段落之間只需空一行即可自然分隔開,無(wú)需額外的標(biāo)點(diǎn)或符號(hào)。當(dāng)你在一行內(nèi)輸入文本,按下回車鍵換行后,如果沒有空行,Markdown 會(huì)默認(rèn)是同一段落,文字會(huì)自動(dòng)連接,保持文本的連貫性。加粗與傾斜
加粗
:若要突出顯示某些重要文字,使其加粗顯示,可使用 ** 或 __ 包裹需要加粗的文本。比如,你想強(qiáng)調(diào)某個(gè)關(guān)鍵詞,寫為 **關(guān)鍵要點(diǎn)** 或 __關(guān)鍵要點(diǎn)__,在渲染后就會(huì)顯示為 關(guān)鍵要點(diǎn),增強(qiáng)文字的視覺沖擊力。
傾斜
:用 * 或 _ 包圍要傾斜的文本,便能讓文字呈現(xiàn)傾斜效果。例如 *這是一句富有詩(shī)意的話* 或 _這是一句富有詩(shī)意的話_,最終顯示為 這是一句富有詩(shī)意的話,可用于增添文字的文藝氛圍或表示引用等。
一、無(wú)序列表
基本語(yǔ)法
:使用 -、+ 或 * 作為列表項(xiàng)標(biāo)記,后面緊跟一個(gè)空格,再輸入列表內(nèi)容。這三種標(biāo)記符號(hào)效果相同,你可以根據(jù)個(gè)人喜好選擇使用。例如:
- 紅色的蘋果
- 黃色的香蕉
- 橙色的橙子
將會(huì)顯示為:
它適用于列舉一些無(wú)序的項(xiàng)目,比如購(gòu)物清單、待辦事項(xiàng)中的任務(wù)分類等,能讓內(nèi)容的呈現(xiàn)更加清晰直觀。嵌套列表
:無(wú)序列表還可以進(jìn)行嵌套,以展示更復(fù)雜的層級(jí)關(guān)系。在子列表項(xiàng)前多添加幾個(gè)空格或一個(gè)制表符(Tab)來(lái)表示層級(jí)縮進(jìn)。例如:
- 水果
- 蘋果
- 紅富士
- 國(guó)光
- 香蕉
- 海南香蕉
- 菲律賓香蕉
- 蔬菜
- 白菜
- 蘿卜
會(huì)呈現(xiàn)為:
- 這樣的嵌套列表可以用于分類詳細(xì)的信息,像目錄結(jié)構(gòu)、知識(shí)體系的細(xì)分等場(chǎng)景,幫助讀者快速理解各項(xiàng)內(nèi)容之間的從屬關(guān)系。
二、有序列表
基本語(yǔ)法
:以數(shù)字加 . 開頭,后面跟一個(gè)空格和列表內(nèi)容,常用于表示有先后順序的步驟或事項(xiàng)。如:
1. 起床洗漱
2. 吃早餐
3. 出門上班
會(huì)呈現(xiàn)為:
- 當(dāng)你在有序列表中間插入或刪除項(xiàng)時(shí),大多數(shù)編輯器通常會(huì)自動(dòng)調(diào)整序號(hào),無(wú)需手動(dòng)更改,省心省力。這使得有序列表在記錄流程、步驟,如烹飪步驟、安裝指南等方面表現(xiàn)出色。
結(jié)合無(wú)序列表使用
:有序列表和無(wú)序列表可以結(jié)合使用,進(jìn)一步豐富文檔結(jié)構(gòu)。例如在一個(gè)項(xiàng)目計(jì)劃文檔中:
1. 項(xiàng)目籌備階段
- 確定項(xiàng)目目標(biāo)
- 組建項(xiàng)目團(tuán)隊(duì)
2. 項(xiàng)目執(zhí)行階段
- 任務(wù)分配
- 開發(fā)任務(wù)
- 測(cè)試任務(wù)
- 進(jìn)度跟蹤
3. 項(xiàng)目收尾階段
- 成果驗(yàn)收
- 項(xiàng)目總結(jié)
呈現(xiàn)出來(lái)后,既能體現(xiàn)項(xiàng)目的整體流程順序,又能對(duì)每個(gè)階段的具體事項(xiàng)進(jìn)行分類羅列,讓文檔邏輯嚴(yán)謹(jǐn)、條理分明,便于團(tuán)隊(duì)成員理解和執(zhí)行項(xiàng)目計(jì)劃。
鏈接
- 鏈接是讓文檔內(nèi)容豐富多元的關(guān)鍵要素,有兩種常見格式:
行內(nèi)式
:最為直接,格式為 [鏈接文字](鏈接地址)。比如,你想分享一個(gè)學(xué)習(xí)網(wǎng)站,可寫為 [慕課網(wǎng)](https://www.imooc.com),在閱讀文檔時(shí),點(diǎn)擊 “慕課網(wǎng)” 這一鏈接文字,就會(huì)跳轉(zhuǎn)到對(duì)應(yīng)的網(wǎng)址,方便讀者獲取更多信息。
參考式
:先在文檔中某個(gè)位置定義鏈接,如 [慕課網(wǎng)]: https://www.imooc.com,然后在需要使用的地方寫 [慕課網(wǎng)] 即可。這種方式特別適用于文檔中多次引用同一鏈接的情況,便于統(tǒng)一管理鏈接地址,當(dāng)鏈接需要修改時(shí),只需更改一處定義,避免了多處修改的繁瑣,維護(hù)起來(lái)更加便捷。
圖片
- 與鏈接類似,圖片的 Markdown 格式為 ![圖片描述](圖片路徑)。例如 ![美麗的夕陽(yáng)](sunset.jpg),若圖片路徑正確,就會(huì)顯示對(duì)應(yīng)的圖片,圖片描述用于在圖片無(wú)法加載時(shí)給用戶提示信息,讓讀者大致了解圖片內(nèi)容,同時(shí)也有助于搜索引擎優(yōu)化(SEO),提升文檔的可讀性和可用性。
引用
> 書籍是人類進(jìn)步的階梯。——高爾基
顯示效果為:
書籍是人類進(jìn)步的階梯。—— 高爾基
> 有人說(shuō):
> > 生活不止眼前的茍且,還有詩(shī)和遠(yuǎn)方。
呈現(xiàn)為:
有人說(shuō):
生活不止眼前的茍且,還有詩(shī)和遠(yuǎn)方。
- 使用 > 符號(hào)來(lái)表示引用,可用于突出顯示名人名言、書籍摘錄、他人觀點(diǎn)等內(nèi)容,讓文檔更具權(quán)威性和可讀性。如:
- 你還可以多層嵌套引用,通過(guò)多個(gè) > 符號(hào)來(lái)實(shí)現(xiàn),如:
代碼塊
def add(a, b):
return a + b
result = add(1, 2)
print(result)
這里指定了 python 語(yǔ)言,代碼塊中的函數(shù)定義、調(diào)用和輸出語(yǔ)句會(huì)按照 Python 的語(yǔ)法高亮規(guī)則顯示,一目了然。
- 對(duì)于程序員或技術(shù)文檔撰寫者來(lái)說(shuō),代碼塊是 Markdown 的重要功能之一。
- 對(duì)于少量代碼,可以用反引號(hào) ` 包裹,如 print('Hello World'),代碼會(huì)以特定樣式顯示,與普通文本區(qū)分開,清晰地展示代碼片段。
- 若要顯示多行代碼,則使用三個(gè)反引號(hào) ```,并可在后面指定代碼語(yǔ)言,以獲得語(yǔ)法高亮效果,幫助讀者更清晰地理解代碼邏輯。例如:
分隔線
- 使用三個(gè)及以上的 - 或 * 來(lái)創(chuàng)建分隔線,例如 --- 或 ***,用于分隔文檔的不同部分,使結(jié)構(gòu)更清晰。比如在文章的章節(jié)轉(zhuǎn)換、開頭結(jié)尾處使用分隔線,能讓文檔層次分明,給讀者視覺上的提示,便于閱讀和理解。
閱讀原文:原文鏈接
該文章在 2024/12/31 11:42:55 編輯過(guò)