vuepress-plugin-component-catalog

vuepress-plugin-component-catalog

This plugin is for generating a component catalog of Vue.js. The catalog page is generated by adding it to the VuePress plugin.

Status: prototype

This plugin is for VuePress Next(v1.x.x).

Install

$ yarn add -D vuepress@next vuepress-plugin-component-catalog

Setting

.vuepress/config.js

module.exports = {
  // ...
  plugins: [
    [
      'vuepress-plugin-component-catalog',
      {
        componentsDir: <your component directory>,
      },
    ],
  ],
};

Docs block

This plugin uses custom blocks of SFC.

example

<docs>
# Base Button

Can be written with Markdown.

VuePress markdown extensions are also available.

[[toc]]

When you write a component, it will be mounted and displayed.

<base-button>Smaple Button</base-button>

<docs>

<template>
  <button type="button"><slot /></button>
</template>

<script>
export default {
  // ...
}
</script>

Example

See example directory.