@vuepress/plugin-register-components

@vuepress/plugin-register-components

register-components plugin for vuepress

Plugin 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.

• Usage:

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

components

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

Register global components by explicit name and path.

• Usage:

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

Changelog

1.0.0-alpha.1 (2018-09-27)

Features

• Plugin API

  • Documentation
  • Multiple official plugins
    • @vuepress/plugin-active-header-links
    • @vuepress/plugin-back-to-top (Thanks to @ycmjason )
    • @vuepress/plugin-blog (For blog theme developers.)
    • @vuepress/plugin-pagination (For blog theme developers.)
    • @vuepress/plugin-google-analytics
    • @vuepress/plugin-last-updated
    • @vuepress/plugin-i18n-ui
    • @vuepress/plugin-medium-zoom
    • @vuepress/plugin-pwa
    • @vuepress/plugin-register-components

• Refined Theme API

  • From now on, the theme will no longer use Layout.vue as the entry point, but you can have your own configuration. For example, a theme can have some built-in plugins.
  • Documentation

• Permalinks

  • From now on, VuePress supports custom routing in addition to the default file-level-based routing.
  • Documentation

• Markdown slots

  • Documentation

• Free to add new pages

  • You can add new pages with content (i.e. pointing to markdown files) or no content (i.e. common routes).
  • Documentation

• Custom temp path

  • The running of VuePress actually depends on some temporary files generated during the build time. Before that, its default location is in node_modules, but now you can start configuring it, but don't forget to add it to gitignore.

    vuepress dev docs --temp .temp # .temp is relative to process.cwd().
    

• Custom temp path

  • In the past, custom layouts were actually implemented by default theme, for now it's moved to core.

• Configurable dev and ssr template

Internal Changes

• Leverage monorepo;
• Decouple @vuepress/core and @vuepress/theme-default
• Rewrite Prepare with Plugin API

<a name="0.14.5"></a>