目錄
1.MarkDown簡介
2.VSCode簡介(Visual Studio Code)
3.VSCode中的MarkDown環境
4.MarkDown相關操作與常用文法
(1)建立新.md檔案
(2)标題
(3)換行與分段
(4)強調(加粗與斜體)
(5)清單(有序&無序)
(6)插入圖檔
(7)數學公式
(8)表格
(9)連結
(10)代碼塊
(11)分割線
(12)引用
(13)流程圖
(14)目錄
(15)md檔案導出為其他檔案
1.MarkDown簡介
Markdown 是一種輕量級标記語言,一個運作于 Mac OS X、Windows和 Linux 之上的,針對于編寫現代Web和雲應用的跨平台源代碼編輯器
Markdown檔案字尾名為 .md
優點:
- 輕量化、易讀易寫
- 對于圖檔,圖表、數學式都有支援
- 許多網站都廣泛使用 Markdown 來撰寫文檔
- 使用标記語言文法編排文檔,簡潔明了
- Markdown可以快速轉化為演講PPT、Word、PDF等産品文檔
- 可用于編寫說明文檔,以“README.md”的檔案名儲存在軟體的目錄下面
2.VSCode簡介(Visual Studio Code)
Visual Studio Code(簡稱“VS Code”)是Microsoft在2015年4月30日Build開發者大會上正式宣布一個運作于 Mac OS X、Windows和 Linux 之上的,針對于編寫現代Web和雲應用的跨平台源代碼編輯器
不僅僅是源代碼編輯器,Visual Studio Code已經成為目前最熱門的文本編輯器。
優點:
- 跨平台
- 開源
- 簡易
- 可擴充,插件豐富
- 輕量快捷
3.VSCode中的MarkDown環境
需先安裝VSCode
在VSCode插件商店中搜尋并安裝以下插件:
- Markdown All in One ——提供豐富的Markdown相關的快捷鍵、自動補全功能,提高md文檔編寫生産力
- Markdown Preview Ehanced ——用于渲染目前編寫文檔的效果同步預覽
- Paste Image ——用于快速引用圖檔至Markdown文檔
注意:安裝完Markdown Preview Ehanced 可能會發生markdown換行相關文法錯誤以下為解決辦法:
下載下傳好所有插件重新開機生效後,需要修改一下設定,點選左下角齒輪按鈕,在搜尋框中輸入break,将搜尋選項中的Markdown Preview Ehanced:Break On Single New Line取消勾選。
以下為取消勾選操作完成圖:
4.MarkDown相關操作與常用文法
(1)建立新.md檔案
在左側檔案夾内建立新的檔案并字尾命名為.md,并點選右上角預覽按鈕同步渲染文本效果
(2)标題
在想要設為标題的文本前進加井号“#”,一級标題加1個“#”,二級加2個,最多為6級
正文則直接寫就好
效果如下:
(3)換行與分段
在MD中,回車并不能換行,隻是将文字加個空格,如下左側編輯器中回車換行,但右側渲染出來的效果隻是空了一格:
想要換行需要在上一行後面加兩個空格再回車
如果要新起一段,則打兩個回車
(4)強調(加粗與斜體)
斜體:在文本兩端各加1個星号”*“ 快捷鍵:ctrl + i
加粗:在文本兩端各加2個星号”*“ 快捷鍵:ctrl + b
(5)清單(有序&無序)
有序清單:輸入1.加一個空格(注意有點”.“),按回車會自動補全編号
如果要輸入分級清單,回車并删除新生成的序列号并再次輸入1.空格
如果要加入新的清單則在兩個清單之間新起一段,或者添加文字
無序清單:輸入星号"*"加空格或者加号"+"加空格或者減号"-"加空格
(6)插入圖檔
複制所需圖檔,在所需插入圖檔位置按下快捷鍵ctrl+alt+v(不是ctrl+v噢),效果如下:
或者手動把圖檔加入md檔案所在檔案夾下,輸入 ![](圖檔檔案名)
(7)數學公式
以下采用latex排版方式對數學公式進行示範,數學公式以 ”\“ 起始
行内展示數學公式:用1個$$括起來 快捷鍵:ctrl+m
另起一段展示數學公式:用兩個$$括起來 快捷鍵:連按兩下ctrl+m
(8)表格
第一行是表頭以”|“區分列
第二行是對齊方式, "-"表示預設對其即左對齊,在"-"左側加":"為左對齊,在右側加":"為右對齊,兩邊都加":"為劇中對齊("-"的個數可随便寫,按照自己的喜好對齊即可,冒号一定要是英文字元!!!)
按下alt+shift+f 可格式化文本編排,效果如下:
(9)連結
複制連結ctrl+v黏貼
直接黏貼則直接生成可點選的連結
選中文字黏貼則生成可點選的文字按鈕連結
(10)代碼塊
用兩行"```"括起來,鍵盤左上方Tab鍵上方的點号,英文輸入法下輸入!!
在第一行"```"後輸入所用語言名字可指定語言提供高亮,如:
```javascript
```
(11)分割線
在所需添加分割線的文本下新起一行輸入三個減号 "---"
(12)引用
在引用的文字前加上大于号">",如下:
(13)流程圖
運用flowchart.js文法
基本文法:tag=>type: content:>url
- tag 元素名字,可自定義
- type 元素類型
- url 引用的連結,點選相應元素可出發連結
注意:冒号和名稱之間需要有一個空格
相關元素類型:
- 開始(橢圓形):start
- 結束(橢圓形):end
- 結束(橢圓形):end
- 多輸出操作(矩形):parallel
- 條件判斷(菱形):condition
- 輸入輸出(平行四邊形):inputoutput
- 預處理/子程式(聖旨形):subroutine
- content就是在框框中要寫的内容,注意type後的冒号與文本之間一定要有個空格。
- url是一個連接配接,與框框中的文本相綁定
關鍵字
- yes/true:condition類型變量連接配接時,用于分别表示yes條件的流向
- no/false:同上,表示否定條件的流向
- left/right:表示連線出口在節點位置(預設下面是出口,如op3),可以跟condition變量一起用:cond(yes,right)
- path1/path2/path3:parallel變量的三個出口路徑(預設下面是出口)
節點狀态
為節點設定不同的狀态,可以通過不同的顔色顯示,其中狀态包括下面6個,含義如英文所示,
- past
- current
- future
- approved
- rejected
- invalid
以下是示例:
```flow
st=>start: 開始
e=>end: 結束
tag1=>operation: 任務1
tag2=>operation: 任務2
cond1=>condition: 是否進行任務2
st->tag1(right)->cond1
cond1(no)->tag1
cond1(yes)->tag2
tag2->e
```
(14)目錄
在要生成目錄的地方輸入 [TOC] ,markdown或根據分級标題自動生成目錄
(15)md檔案導出為其他檔案
點選markdown preview ehanced提供的渲染預覽按鈕(使用這個渲染方式下導出的檔案數學公式比較可靠亂碼機率較小)(滑鼠移植按鈕上方提示markdown preview ehanced相關或者MPE相關)
如果隻有看見一個預覽按鈕,那就是markdown preview ehanced隐藏了vscode自帶的markdown文檔預覽按鈕,是以隻顯示了一個markdown preview ehanced的預覽按鈕,直接用就好。
若想恢複vscode自帶的markdown文檔預覽按鈕,則點選左下角齒輪按鈕進入設定,搜尋"Hide Default VSCode Markdown Preview Buttons"取消勾選即可,如下為恢複狀态:
在預覽界面中右鍵,選擇谷歌浏覽器導出為PDF