Sphinx+github+ReadtheDocs書寫筆記
782
2025-04-01
華為云社區可以通過markdown編輯器書寫博客內容。除了一些不常用的markdown語法暫時無法使用外,我們依然可以正常地學習并使用相關內容。
我之前使用的Markdown編輯器是
鑒于幾次忘記保存或者意外丟失草稿的悲慘經歷,我“痛心疾首、 深惡痛絕、 痛哭流涕、 痛定思痛、 痛改前非”。
華為云社區寫博客時會定時將草稿保存到華為云的服務器上。因此,我們在社區記錄內容是個不錯的選擇。
下面開始了解Markdown
Markdown是一種輕量級的標記語言,可用于將格式設置元素添加到純文本文檔中,然后轉換成有效的XHTML(或者HTML)文檔。Markdown有著輕量化優勢、易讀易寫特性,并且對于圖片,圖表、數學式都有支持。
轉換過程如下
注意:既然Markdown最終轉換的是XHTML(或者HTML)文檔,這意味著我們也可使用使用HTML進行書寫。我們可以將HTML標簽添加到任何Markdown文件中,伴隨著HTML各種屬性特性,可以呈現出原來Markdown語法所沒有的效果。
例如
標題
創建標題,請在單詞或短語的前面添加數字符號(#)。所使用的數字符號的數量應與標題級別相對應。例如,要創建標題級別三(
注意:#與內容之間有空格
替代語法
或者,在文本下方的行上,添加任意數量的==標題級別1的--字符或標題級別2的字符。
粗體
要加粗文本,請在單詞或短語的前后添加兩個星號或下劃線。要加粗一個單詞的中部以強調,請在字母周圍添加兩個星號,且各空格之間不加空格。
斜體
要斜體顯示文本,請在單詞或短語的前后添加一個星號或下劃線。要斜體突出單詞的中間部分,請在字母周圍添加一個星號,中間不要帶空格。
粗體+斜體
要同時突出顯示帶有粗體和斜體的文本,請在單詞或短語的前后添加三個星號或下劃線。
塊引用
要創建塊引用,請在>后添加一個空格。
若上下不存在空格或>會擠到一塊兒。
嵌套塊引用
塊引用可以嵌套。>>在要嵌套的段落前面添加一個。
具有其他元素的塊引用
有序列表
要創建有序列表,請在訂單項中添加數字和句點。數字不必按數字順序排列,但列表應以數字開頭。
無序列表
要創建無序列表,請在訂單項前添加破折號(-),星號(*)或加號(+)。
縮進一個或多個項目以創建嵌套列表。
在列表中添加元素
要在保留列表連續性的同時在列表中添加另一個元素,請將該元素縮進四個空格或一個制表符,如以下示例所示。
塊引用
代碼塊
代碼塊通常縮進四個空格或一個制表符。當它們在列表中時,將它們縮進八個空格或兩個制表符(Tab鍵)。
圖片
代碼
要將單詞或短語表示為代碼,請將其括在勾號(`)中。
轉義刻度線
如果要表示為代碼的單詞或短語包含一個或多個刻度線,可以通過將單詞或短語括在雙刻度線(``)中來對其進行轉義。
水平線
要創建水平線***,請單獨在一行上使用三個或更多的星號(),破折號(---)或下劃線(___)。
鏈接
要創建鏈接,請將鏈接文本括在方括號(例如[LongYorke])中,然后立即在URL后面加上括號(例如(https://bbs-img.huaweicloud.com/user/img/head/1606906698695_5081_2792.png)) 。
添加標題
您可以選擇為鏈接添加標題。當用戶將鼠標懸停在鏈接上時,這將顯示為工具提示。要添加標題,請將其在URL括號中的“”添加。
這是 [LongYorke](https://bbs-img.huaweicloud.com/user/img/head/1606906698695_5081_2792.png "這是頭像")圖片連接.
網址和電子郵件地址
要將URL或電子郵件地址快速轉換為鏈接,請將其括在尖括號中。
格式化鏈接
為了強調鏈接,請在方括號和括號之前和之后添加星號。
鏈接圖像
要向圖像添加鏈接,請將圖像的Markdown括在方括號中,然后在括號中添加鏈接。
[](https://bbs.huaweicloud.com/community/usersnew/id_1597833162983106)
顯示頭像圖片,點擊后指向博客地址
轉義字符
要顯示原義字符,否則將用于設置Markdown文檔中的文本格式\,請在字符前面添加反斜杠()。
可以轉義的字符
可以使用反斜杠轉義以下字符。
表格
表格使用|來分隔不同的單元格,使用-來分隔表頭和其他行。
可以設置表格的對齊方式:
-: 設置內容和標題欄居右對齊。
:- 設置內容和標題欄居左對齊。
:-: 設置內容和標題欄居中對齊。
Markdown
版權聲明:本文內容由網絡用戶投稿,版權歸原作者所有,本站不擁有其著作權,亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容,請聯系我們jiasou666@gmail.com 處理,核實后本網站將在24小時內刪除侵權內容。
版權聲明:本文內容由網絡用戶投稿,版權歸原作者所有,本站不擁有其著作權,亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容,請聯系我們jiasou666@gmail.com 處理,核實后本網站將在24小時內刪除侵權內容。