MUME

This library powers:

• markdown preview enhanced for atom
• markdown preview enhanced for vscode

This documentation will be released sooooon...

npm install --save @shd101wyy/mume

Example

// node.js 
const mume = require('@shd101wyy/mume')

// es6
// import * as mume from "@shd101wyy/mume"

async function main() {
  await mume.init()

  const engine = new mume.MarkdownEngine({
    filePath: "/Users/wangyiyi/Desktop/markdown-example/test3.md",
    config: {
      previewTheme: "github-light.css",
      // revealjsTheme: "white.css"
      codeBlockTheme: "default.css",  
      printBackground: true
    }
  })

  // 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})

  return process.exit()
}

main()

Markdown Engine Configuration

const config = {
  // Enable this option will render markdown by pandoc instead of markdown-it.
  usePandocParser: false,

  // In Markdown, a single newline character doesn't cause a line break in the generated HTML. In GitHub Flavored Markdown, that is not true. Enable this config option to insert line breaks in rendered HTML for single newlines in Markdown source.
  breakOnSingleNewLine: true,

  // Enable smartypants and other sweet transforms.
  enableTypographer: false,

  // Math
  mathRenderingOption: "KaTeX",  // "KaTeX" | "MathJax" | "None"
  mathInlineDelimiters: [["$", "$"], ["\\(", "\\)"]],
  mathBlockDelimiters: [["$$", "$$"], ["\\[", "\\]"]],

  // Enable Wiki Link syntax support. More information can be found a  https://help.github.com/articles/adding-links-to-wikis/ 
  enableWikiLinkSyntax: true,
  // By default, the extension for wikilink is `.md`. For example: [[test]] will direct to file path `test.md`.
  wikiLinkFileExtension: '.md'

  // Enable emoji & font-awesome plugin. This only works for markdown-it parser, but not pandoc parser.  
  enableEmojiSyntax: true

  // Enable extended table syntax to support merging table cells.  
  enableExtendedTableSyntax: false

  // Enable CriticMarkup syntax. Only works with markdown-it parser.  
  // Please check http://criticmarkup.com/users-guide.php for more information.  
  enableCriticMarkupSyntax: false

  // Front matter rendering option
  frontMatterRenderingOption: 'table', // 'table' | 'code block' | 'none'

  // Mermaid theme 
  mermaidTheme: 'mermaid.css', // 'mermaid.css' | 'mermaid.dark.css' | 'mermaid.forest.css'

  // Code Block theme
  // If `auto.css` is chosen, then the code block theme that best matches the current preview theme will be picked.
  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",
  //  "vs.css",
  //  "xonokai.css" 

  // Preview theme
  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"

  // Revealjs presentation theme
  revealjsTheme: "white.css"
  // "beige.css"
  // "black.css"
  // "blood.css"
  // "league.css"
  // "moon.css"
  // "night.css"
  // "serif.css"
  // "simple.css"
  // "sky.css"
  // "solarized.css"
  // "white.css"
  // "none.css"

  // Accepted protocols followed by `://` for links.
  protocolsWhiteList: "http, https, atom, file",

  // When using Image Helper to copy images, by default images will be copied to root image folder path '/assets'
  imageFolderPath: '/assets',

  // Whether to print background for file export or not. If set to `false`, then `github-light` preview theme will b  used. You can also set `print_background` in front-matter for individual files.
  printBackground: false,

  // PhantomJS executable path
  phantomPath: 'phantomjs',

  // Pandoc executable path
  pandocPath: 'pandoc',

  // Pandoc markdown flavor
  pandocMarkdownFlavor: "markdown-raw_tex+tex_math_single_backslash",

  // Pandoc arguments e.g. ['--smart', '--filter=/bin/exe']. Please use long argument names.
  pandocArguments: [],

  // Default latex engine for Pandoc export and latex code chunk.
  latexEngine: 'pdflatex',

  // Whether to enable script execution.
  // Disabling this will prevent executing code chunks and importing javascript files.  
  enableScriptExecution: true
}

// Init Engine
const engine = new mume.MarkdownEngine({
  filePath: '...',
  projectDirectoryPath: '...',
  config: config
})

Global Configuration

Global config files are located at ~/.mume directory

Development

Visual Studio Code is recommended.
Clone this project, npm install, open in vscode, then cmd+shift+b to build.