優(yōu)秀的Markdown引擎-MUME

因項(xiàng)目需要豫喧,嘗試了[markdown.js]和[GitHub的Markdown Web API]舆蝴,都不盡如人意谦絮,于是將目標(biāo)對準(zhǔn)了大名鼎鼎Markdown Preview Enhanced插件,翻其源碼洁仗,最終挖出的背后功臣MUME层皱。
如此優(yōu)秀的Markdown引擎,其在GitHub上的Star僅有83個赠潦,著實(shí)讓人意外叫胖。

閱讀原文

調(diào)用簡單

以導(dǎo)出為html為例:

//引入
const mume = require("@shd101wyy/mume");

async function main() {
  // 初始化
  await mume.init();
  
  // 創(chuàng)建Markdown Engine實(shí)例
  const engine = new mume.MarkdownEngine({
    filePath: "/Users/wangyiyi/Desktop/markdown-example/test3.md",
    config: {
      previewTheme: "github-light.css",
      codeBlockTheme: "default.css",
      printBackground: true,
      enableScriptExecution: true, // <= for running code chunks
    },
  });

  // 導(dǎo)出Markdown為html格式
  await engine.htmlExport({ offline: false, runAllCodeChunks: true });
}
main();

上面代碼中完成了mume的導(dǎo)入初始化她奥,源文件指定瓮增,目標(biāo)樣式指定導(dǎo)出

功能強(qiáng)大

導(dǎo)出多種格式

在官方示例代碼中可以清晰的看到:

  // open in browser
  await engine.openInBrowser({ runAllCodeChunks: true });

  // html export
  await engine.htmlExport({ offline: false, runAllCodeChunks: true });

  // chrome (puppeteer) export
  await engine.chromeExport({ fileType: "pdf", runAllCodeChunks: true }); // fileType = 'pdf'|'png'|'jpeg'

  // phantomjs export
  await engine.phantomjsExport({ fileType: "pdf", runAllCodeChunks: true }); // fileType = 'pdf'|'png'|'jpeg'

  // prince export
  await engine.princeExport({ runAllCodeChunks: true });

  // ebook export
  await engine.eBookExport({ fileType: "epub" }); // fileType=`epub`|`pdf`|`mobi`|`html`

  // pandoc export
  await engine.pandocExport({ runAllCodeChunks: true });

  // markdown(gfm) export
  await engine.markdownExport({ runAllCodeChunks: true });

自帶豐富樣式

  • 預(yù)覽樣式
    previewTheme: 'github-light.css',
    // "atom-dark.css",
    // "atom-light.css",
    // "atom-material.css",
    // "github-dark.css",
    // "github-light.css",
    // "gothic.css",
    // "medium.css",
    // "monokai.css",
    // "newsprint.css",
    // "night.css",
    // "none.css",
    // "one-dark.css",
    // "one-light.css",
    // "solarized-dark.css",
    // "solarized-light.css"
    // "vue.css"
    
  • 代碼塊樣式
    codeBlockTheme: 'auto.css',
    //  "auto.css",
    //  "default.css",
    //  "atom-dark.css",
    //  "atom-light.css",
    //  "atom-material.css",
    //  "coy.css",
    //  "darcula.css",
    //  "dark.css",
    //  "funky.css",
    //  "github.css",
    //  "hopscotch.css",
    //  "monokai.css",
    //  "okaidia.css",
    //  "one-dark.css",
    //  "one-light.css",
    //  "pen-paper-coffee.css",
    //  "pojoaque.css",
    //  "solarized-dark.css",
    //  "solarized-light.css",
    //  "twilight.css",
    //  "vue.css"
    //  "vs.css",
    //  "xonokai.css"
    
    • 幾個樣例


      mume-demo1.png
mume-demo2.png
mume-demo3.png
mume-demo4.png
mume-demo5.png

支持?jǐn)?shù)學(xué)公式渲染

  • KaTeX渲染庫
  • MathJax渲染庫

導(dǎo)出代碼易用

MUME導(dǎo)出的html代碼結(jié)構(gòu)清晰,便于修改再利用


mume-htmlcode.png

其他

更多功能請見官方GitHub庫說明

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末哩俭,一起剝皮案震驚了整個濱河市钉赁,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌携茂,老刑警劉巖你踩,帶你破解...
    沈念sama閱讀 207,113評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異讳苦,居然都是意外死亡带膜,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評論 2 381
  • 文/潘曉璐 我一進(jìn)店門鸳谜,熙熙樓的掌柜王于貴愁眉苦臉地迎上來膝藕,“玉大人,你說我怎么就攤上這事咐扭“磐欤” “怎么了滑废?”我有些...
    開封第一講書人閱讀 153,340評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長袜爪。 經(jīng)常有香客問我蠕趁,道長,這世上最難降的妖魔是什么辛馆? 我笑而不...
    開封第一講書人閱讀 55,449評論 1 279
  • 正文 為了忘掉前任俺陋,我火速辦了婚禮,結(jié)果婚禮上昙篙,老公的妹妹穿的比我還像新娘腊状。我一直安慰自己,他們只是感情好苔可,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,445評論 5 374
  • 文/花漫 我一把揭開白布缴挖。 她就那樣靜靜地躺著,像睡著了一般焚辅。 火紅的嫁衣襯著肌膚如雪醇疼。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,166評論 1 284
  • 那天法焰,我揣著相機(jī)與錄音,去河邊找鬼倔毙。 笑死埃仪,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的陕赃。 我是一名探鬼主播卵蛉,決...
    沈念sama閱讀 38,442評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼么库!你這毒婦竟也來了傻丝?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,105評論 0 261
  • 序言:老撾萬榮一對情侶失蹤诉儒,失蹤者是張志新(化名)和其女友劉穎葡缰,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體忱反,經(jīng)...
    沈念sama閱讀 43,601評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡泛释,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,066評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了温算。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片怜校。...
    茶點(diǎn)故事閱讀 38,161評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖注竿,靈堂內(nèi)的尸體忽然破棺而出茄茁,到底是詐尸還是另有隱情魂贬,我是刑警寧澤,帶...
    沈念sama閱讀 33,792評論 4 323
  • 正文 年R本政府宣布裙顽,位于F島的核電站付燥,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏锦庸。R本人自食惡果不足惜机蔗,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,351評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望甘萧。 院中可真熱鬧萝嘁,春花似錦、人聲如沸扬卷。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,352評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽怪得。三九已至咱枉,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間徒恋,已是汗流浹背蚕断。 一陣腳步聲響...
    開封第一講書人閱讀 31,584評論 1 261
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留入挣,地道東北人亿乳。 一個月前我還...
    沈念sama閱讀 45,618評論 2 355
  • 正文 我出身青樓,卻偏偏與公主長得像径筏,于是被迫代替她去往敵國和親葛假。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,916評論 2 344

推薦閱讀更多精彩內(nèi)容