VuePress

# @vuepress/plugin-register-components (opens new window)

register-components plugin for VuePress

# Install

yarn add -D @vuepress/plugin-register-components
# OR npm install -D @vuepress/plugin-register-components

# Usage

module.exports = {
  plugins: ['@vuepress/register-components']
}

# Options

# componentsDir

  • Type: Array | String
  • Default: []

All components in this directory will be registered as global components, naming of components will follow the components found in .vuepress/components (opens new window).

module.exports = {
  plugins: [
    [
      'register-components',
      {
        componentsDir: somepath
      }
    ]
  ]
}

# components

  • Type: { name: string, path: string }
  • Default: []

Register global components by explicit name and path.

module.exports = {
  plugins: [
    [
      'register-components',
      {
        components: [
          {
            name: 'V-Card',
            path: 'path/to/card.vue'
          }
        ]
      }
    ]
  ]
}

# getComponentName

  • Type: (file: string) => string
  • Default: file => file.replace(/\/|\\/g, '-')

Customize component names for files under componentsDir.

← search →