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

Bug Fixes

• $core: changing frontmatter always took a long time to refresh page (68add19) @ulivz
  • From now on AppContext has become a singleton.

Features

• $cli: allow unknown options in dev and build command (0ecd099) @ulivz
• $core: debug to see performance (0876491) @ulivz
  • Using --developer flag to see the performance for 1st dev and build. note that --developer flag is a separate flag which doesn't have log level.
• $core: support Vue SFCs as source files (dfb0bba) @ulivz
  • Note that when Vue SFCs are source files, VuePress will treat them as layout components directly.

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