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