2.2 愉快寫文檔:VSCode + Markdown Preview Enhanced

本章導(dǎo)航:

  • 1. 介紹 MPE噩茄。
  • 2. 簡(jiǎn)要介紹幾個(gè)十分好用的 MPE 的功能账蓉。

使用電腦環(huán)境:Windows10皮璧。本章主要參考 MPE 官方中文文檔疑俭。

3.1 Markdown Preview Enhanced 簡(jiǎn)介

在開始閱讀 MPE(Markdown Preview Enhanced)的功能之前,您需要在 vscode 的應(yīng)用商店搜索并安裝 Markdown Preview Enhanced 插件伍玖。

在 MPE 的安裝界面提供了十分詳細(xì)的使用文檔嫩痰,且完美地支持中文。說(shuō)明文檔鏈接:Markdown Preview Enhanced 英文|中文窍箍。

Markdown Preview Enhanced 是一款為 Atom 以及 Visual Studio Code 編輯器編寫的超級(jí)強(qiáng)大的 Markdown 插件串纺。 這款插件意在讓你擁有飄逸的 Markdown 寫作體驗(yàn)∫—— MPE 官方介紹纺棺。

使用 vscode 編寫 .md 文件時(shí),可以使用組合快捷鍵 Ctrl + K V 打開 MPE 的側(cè)邊預(yù)覽邪狞,來(lái)實(shí)時(shí)的查看 markdown 的預(yù)覽結(jié)果祷蝌。

在 vscode 中支持放大鏡功能:cmd + 放大,cmd - 縮小外恕。輔助該放大鏡功能杆逗,您將會(huì)獲得不一樣的體驗(yàn)。

3.2 MPE 基礎(chǔ)語(yǔ)法

markdown 基礎(chǔ)語(yǔ)法可查閱《2.1 Markdown 使用手冊(cè)》鳞疲。下面主要介紹 MPE 特有的幾個(gè)語(yǔ)法罪郊。

3.2.1 代碼顯示行數(shù)與高亮

例3.1 只需要在代碼的名稱后面添加 {.line-numbers} 即可為代碼添加行數(shù):

```python {.line-numbers}
a = 1
b = 7
c = a + b
```

輸出預(yù)覽結(jié)果:

a = 1
b = 7
c = a + b

例3.2 在代碼名稱后添加 {highlight=[2-3, 10-14]} 這種形式,可以為指定代碼提供高亮設(shè)置尚洽。如果需求僅僅是一個(gè)連續(xù)的行高亮悔橄,可以這樣:

```python {highlight=2-4}
a = 1
b = 7
c = a + b
d = a ** c
e = a - d
```

3.2.2 任務(wù)列表

- [ ] 未完成
- [x] 已完成

3.2.3 上下標(biāo)

符號(hào) 說(shuō)明 示例
^^ 上標(biāo)
~~ 下標(biāo)

3.2.4 導(dǎo)入外部文件

語(yǔ)法:@import "你的文件" 或者

支持的文件類型

  • .jpeg(.jpg), .gif, .png, .apng, .svg, .bmp 文件將會(huì)直接被當(dāng)作 markdown 圖片被引用。
  • .csv 文件將會(huì)被轉(zhuǎn)換成 markdown 表格腺毫。
  • .mermaid 將會(huì)被 mermaid 渲染癣疟。
  • .dot 文件將會(huì)被 viz.js (graphviz) 渲染。
  • .plantuml(.puml) 文件將會(huì)被 PlantUML 渲染潮酒。
  • .html 將會(huì)直接被引入睛挚。
  • .js 將會(huì)被引用為 <script src="你的 js 文件"></script>
  • .less.css 將會(huì)被引用為 style急黎。目前 less 只支持本地文件扎狱。.css 文件將會(huì)被引用為 <link rel="stylesheet" href="你的 css 文件">。
  • .pdf 文件將會(huì)被 pdf2svg 轉(zhuǎn)換為 svg 然后被引用勃教。
  • markdown 將會(huì)被分析處理然后被引用淤击。
  • 其他所有的文件都將被視為代碼塊。

例3.3:導(dǎo)入圖片

@import "test.png" {width="300px" height="200px" title="圖片的標(biāo)題" alt="我的 alt"}

例3.4 引用文件作為 Code Chunk:

@import "test.py" {cmd="python3", class="line-numbers"}

例3.5 作為代碼塊:

@import "test.json" {as="vega-lite"}

當(dāng)然可以插入 Markdown故源,這樣很有意思污抬。除了把多個(gè)小文檔合并成一個(gè)大文檔這種無(wú)腦的用法之外,我覺(jué)得最有潛力的用法是——非線性寫作吧印机!

如果我們把一些小文件當(dāng)作卡片的話矢腻,善用導(dǎo)入文件功能就可以實(shí)現(xiàn)類似 Scrivener 的功能了。雖然用戶體驗(yàn)上相差甚遠(yuǎn)耳贬,但是免費(fèi)啊踏堡。

3.2.5 導(dǎo)入目錄

在 vscode 中,只需要在需要生成目錄的地方放入 [TOC] 便會(huì)自動(dòng)生成目錄咒劲。對(duì)于 [TOC] 不生效的情況顷蟆,可以使用 `` 代替其自動(dòng)生成目錄渺氧。

3.2.6 使用表情符號(hào)Front Icon

參考:GitHub Help:Emoji藤违。

通過(guò)鍵入 :EMOJICODE: 可在您的寫作中添加表情符號(hào)。

@octocat :+1: 這個(gè) PR 看起來(lái)很棒 - 可以合并了御雕! :shipit:

圖3.1 渲染的表情符號(hào)

鍵入 : 將顯示建議的表情符號(hào)列表蛔屹。 列表將在您鍵入時(shí)進(jìn)行過(guò)濾削樊,因此一旦找到所需表情符號(hào),請(qǐng)按 TabEnter 鍵以填寫選中的結(jié)果兔毒。

有關(guān)可用表情符號(hào)和代碼的完整列表漫贞,請(qǐng)查看 emoji-cheat-sheet.com。您也可以參考 Font Awesome 設(shè)置 Front Icon育叁。

3.3 在文檔里面跑代碼

為了令 MPE 可以運(yùn)行代碼(Code Chunk)迅脐,您需要在 vscode 的設(shè)置里搜索 MPE,找到 Markdown-preview-enhanced: Enable Script Execution 在其前復(fù)選框?豪嗽,以開啟 Code Chunk谴蔑。開啟之后,您便可以直接在 markdown 中運(yùn)行代碼了龟梦。

使用快捷鍵 ctrl + shift + P 打開 MPE 運(yùn)行代碼的提示框:

圖3.2 打開 MPE 運(yùn)行代碼提示框

需要在代碼名稱的后面添加隐锭,類似下面的命令:

```python {cmd=true, class="line-numbers"}
print(2*4)
```

下面可以看一個(gè)示例圖:

圖3.3 在文檔里面跑代碼

cmd=true 是默認(rèn)您的 vscode 可以自動(dòng)識(shí)別 Python 環(huán)境的。计贰,如果您需要指定特殊的環(huán)境可以像 cmd="/usr/local/bin/python3" 這樣設(shè)置钦睡。

3.4 畫圖

圖3.4 使用 Mermaid 畫了一個(gè)類圖:

classDiagram
類別1 <|-- AveryLongClass : Cool
類別3 *-- 類別4
類別5 o-- 類別6
類別7 .. 類別8
類別9 --> 類別2 : Where am i?
類別9 --* 類別3
類別9 --|> 類別7
類別7 : equals()
類別7 : Object[] elementData
類別1 : size()
類別1 : int chimp
類別1 : int gorilla
類別8 <--> 類別2: Cool label
圖3.4 mermaid 畫類圖

更多與 Mermaid 相關(guān)的使用語(yǔ)法,可以??Mermaid 學(xué)習(xí)躁倒。

更多與畫圖相關(guān)的內(nèi)容可以參閱 MPE:圖像赎婚。

3.5 小結(jié)

本章主要討論了 MPE 的一些常用語(yǔ)法。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
禁止轉(zhuǎn)載樱溉,如需轉(zhuǎn)載請(qǐng)通過(guò)簡(jiǎn)信或評(píng)論聯(lián)系作者。
  • 序言:七十年代末纬凤,一起剝皮案震驚了整個(gè)濱河市福贞,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌停士,老刑警劉巖挖帘,帶你破解...
    沈念sama閱讀 218,858評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件完丽,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡拇舀,警方通過(guò)查閱死者的電腦和手機(jī)逻族,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)骄崩,“玉大人聘鳞,你說(shuō)我怎么就攤上這事∫鳎” “怎么了抠璃?”我有些...
    開封第一講書人閱讀 165,282評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)脱惰。 經(jīng)常有香客問(wèn)我搏嗡,道長(zhǎng),這世上最難降的妖魔是什么拉一? 我笑而不...
    開封第一講書人閱讀 58,842評(píng)論 1 295
  • 正文 為了忘掉前任采盒,我火速辦了婚禮,結(jié)果婚禮上蔚润,老公的妹妹穿的比我還像新娘磅氨。我一直安慰自己,他們只是感情好抽碌,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,857評(píng)論 6 392
  • 文/花漫 我一把揭開白布悍赢。 她就那樣靜靜地躺著,像睡著了一般货徙。 火紅的嫁衣襯著肌膚如雪左权。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,679評(píng)論 1 305
  • 那天痴颊,我揣著相機(jī)與錄音赏迟,去河邊找鬼。 笑死蠢棱,一個(gè)胖子當(dāng)著我的面吹牛锌杀,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播泻仙,決...
    沈念sama閱讀 40,406評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼糕再,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了玉转?” 一聲冷哼從身側(cè)響起突想,我...
    開封第一講書人閱讀 39,311評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后猾担,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體袭灯,經(jīng)...
    沈念sama閱讀 45,767評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年绑嘹,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了稽荧。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,090評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡工腋,死狀恐怖姨丈,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情夷蚊,我是刑警寧澤构挤,帶...
    沈念sama閱讀 35,785評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站惕鼓,受9級(jí)特大地震影響筋现,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜箱歧,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,420評(píng)論 3 331
  • 文/蒙蒙 一矾飞、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧呀邢,春花似錦洒沦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,988評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至蝉衣,卻和暖如春括尸,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背病毡。 一陣腳步聲響...
    開封第一講書人閱讀 33,101評(píng)論 1 271
  • 我被黑心中介騙來(lái)泰國(guó)打工濒翻, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人啦膜。 一個(gè)月前我還...
    沈念sama閱讀 48,298評(píng)論 3 372
  • 正文 我出身青樓有送,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親僧家。 傳聞我的和親對(duì)象是個(gè)殘疾皇子雀摘,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,033評(píng)論 2 355