@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.28 (2018-12-12)

Bug Fixes

• $cli: bump CAC version (#1062) (172afa3) @spiltcoffee
• $core: async function support for plugin option additionalPages (close: #1077)(#1080) (3095106) @Jan Vennemann
• $core: 'slotKey' must be defined as props in user's markdown's script tag (close: #975) (ece2e1e) @ulivz
• $core: remove smoothing scroll (close: #1071) (#1075) (26c0628) @Daniel Castillo
• $theme-default: fix height of input in SearchBox for IE11 (#1093) (04510e9) @Dylan Broussard

Features

• $core: pass generated page paths to generated hook (#925) (5ee2b2b) @Michael Smith
• $core: extendCli Plugin Option API (#1069) (e963731) @ulivz
  • See docs.
• $plugin-search: searchable paths with test RegExp (#1032) (d6bddf1) @Robson Tenório

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