關於markdown實操備忘錄
引言:
使用markdown編寫文檔,可以快速生成 排版格式良好、可讀性強的文檔,目前大部分博客,都是基於該方法去編輯生成。
在學習和使用markdown之前,瞭解html(超文本標誌語言)和 XML(可擴展標誌語言)的概念, 對使用markdown有很大幫助。 二者的語法十分接近, 只是使用場合不一樣,存在一些細節上的語法差異。
- XML主要用來描述數據,比如數據庫中,數據描述和數據傳輸的使用場合, ROS系統gazebo當中,用於描述模型數據。Sysrepo當中用於描述頁面配置的數據。
- HTML 應用於顯示數據和顯示數據外觀,也就是描述我們的網頁框架。
- 而markdown 和HTML的關係則更爲接近,** Markdown 可算是 HTML 的一個簡化了標記形式的子集。**,所以當我們使用markdown 編輯時,有些文本,圖像等內容無法較爲理想地表現出來的時候,我們便可以使用HTMl 進行矯正補充。
- Windows這兩年做的VisualStudioCode不錯, 可以編輯很多代碼語言,插件豐富,啓動速度快,終端命令輸入,跨平臺,完全免費,可以支持很多插件:
Markdown Preview Mermaid Support 支持繪製思維導圖
Markdown Preview Enhanced 效果預覽 - 在需要表達特別多級的內容的時候,不建議一味地使用* ,# 等操作符。可以標識具體數字,比如
2
2.1
2.2
這樣表述觀點,會直觀得多,免得過多項目, 後面分不清有幾點內容。
簡記:
- 六級標題:
###### 標題 (注意內容和標識符之間有小空格,六級就是正常字體加粗)
標題
- 五級標題:
##### 標題
標題
- 四級標題:
#### 標題
標題
- 三級標題:
### 標題
標題
- 二級標題:
## 標題
標題
- 一級標題:
# 標題
標題
-
文字傾斜:
*文字*
文字 -
文字加粗:
**文字**
文字 -
文字加粗並傾斜:
***文字***
文字 -
換行:
空格+空格+回車
-
突出內容,加上背景陰影: ` 內容 `
內容
-
高亮內容:
==內容==
內容 -
插入鏈接:
<https://editor.csdn.net/>
https://editor.csdn.net/ -
給鏈接取名字:
[CSDN](https://www.csdn.com)
CSDN -
插入圖片:
![圖片](https://www.csdn.com)
網頁鏈接
![圖片](./)
本地相對路徑
![圖片](base64壓縮碼)
通過base64 壓縮圖片得到的編碼,html中有的圖片也是通過這種形式加入的,太醜了,整個插入的壓縮碼看起來十分冗長。 -
使用編程語言和特殊格式來插入內容:
```c [ c++, sh, python, js …etc ]
int main()
{return 0;}
```
C代碼
int main()
{return 0;}
- 當markdown中的特殊字符已經被markdown 賦予用途的時候, 而又想使用的時候,通過
用反斜槓\ 來轉義。
\# 顯示#號
\> 引用的作用被消除, 表示字符 ">"。
使用思維導圖, 餅形圖
官網教程: https://mermaid-js.github.io/mermaid/#/
```mermaid
graph LR; LR 表示從左到右展開, TB 表示從上到下展開
A–>B;
A–>C;
```
- 邏輯圖
- 時序圖
- 圓餅圖
- 甘特圖(橫條圖), CSDN 不支持甘特圖。 用來表達網絡頁面的加載流程,NICE!
- 類歸屬圖, 面嚮對象語言的類函數繼承說明。