@vuepress/markdown

@vuepress/markdown

markdown library for vuepress

Public API

PLUGINS

A map constant containing the names of all built-in markdown-it plugins.

isRequiredPlugin(pluginName: string)

• Usage:

const { isRequiredPlugin } = require('@vuepress/markdown')
console.log(isRequiredPlugin(PLUGINS.COMPONENT)) // true
console.log(isRequiredPlugin(PLUGINS.HIGHLIGHT_LINES)) // false

removePlugin(config: chainMarkdown, pluginName: string)

Remove the specified built-in markdown-it plugin in VuePress.

It's needed to use with VuePress's Plugin API > chainMarkdown.

• Usage:

// Your VuePress Plugin or site config.
const { removePlugin } = require('@vuepress/markdown')
module.exports = {
  chainMarkdown (config) {
    removePlugin(config, PLUGINS.HIGHLIGHT_LINES)
  }
}

Note that PLUGINS.COMPONENT and PLUGINS.ANCHOR are required in VuePress, It is forbidden to delete them!

removeAllBuiltInPlugins(config: chainMarkdown)

Remove all built-in but not 100% necessary markdown-it plugins in VuePress.

• Usage:

// Your VuePress Plugin or site config.
module.exports = {
  chainMarkdown (config) {
    require('@vuepress/markdown').removeAllBuiltInPlugins(config)
  }
}

Changelog

1.0.0-alpha.40 (2019-02-27)

Bug Fixes

• $cli: re-support option --open (close: #1320) (#1329) (b97e9ee) @Shigma
• $core: handle redirect based on lower case (#1333) (505fea6) @Shigma
• $core: update outbound link icon alignment (#1308) (6de1c30) @George Tsiolis
• $plugin-pwa: service worker doesn't work under sub directory (close: #1311) (0d56a99) @ulivz

Features

• $core: refine theme api (d16d3d5) @ulivz(#1319)
  • Check out Theme Inheritance for more details.
• $markdown: code snippet hmr (close #1309) (#1358) (8f83a17) @Shigma
• $markdown: refine markdown api (#1337) (b79768c) @Shigma
• $markdown: cache parser (#1359) (f04adbf) @Shigma
• $theme-default: add ruby shortcut rb support for syntax highlighting (#1312) (dad2928) @Fabio Anselmo
• $theme-default: should allow for optional h1 text at homepage (#1326) (598799f) @Ahmad Nassri
• $plugin-clean-urls: init (#1339) (40b3da8) @Shigma

<a name="1.0.0-alpha.39"></a>