Vuex Vuedoc Plugin

This adds support of Vuex on Vuedoc

Install

This package is ESM only : Node 16+ is needed to use it and it must be imported instead of required.

npm install --save @vuedoc/plugin-vuex

Usage

Usage with Vuedoc Markdown

// vuedoc.config.js
import { Loader } from '@vuedoc/parser';
import { createVuexPlugin } from '@vuedoc/plugin-vuex';

export default {
  output: 'docs/',
  parsing: {
    plugins: [
      createVuexPlugin([
        'path/to/store.js',
      ]),
    ],
  },
};

Then:

vuedoc-md --config vuedoc.config.js components/*.vue

Usage with Vuedoc Parser

import { parseComponent } from '@vuedoc/parser';
import { createVuexPlugin } from '@vuedoc/plugin-vuex';

const component = await parseComponent({
  filename: 'test/examples/classic/counter-hot/CounterControls.vue',
  plugins: [
    createVuexPlugin([
      'path/to/store.js',
    ]),
  ],
});

Development Setup

1. Install Nix Package Manager

2. Install direnv with your OS package manager

3. Hook it direnv into your shell

4. At the top-level of your project run:

   direnv allow

   The next time your launch your terminal and enter the top-level of your project, direnv will check for changes.

Versioning

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards-compatible manner, and
• PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

See SemVer.org for more details.

License

Under the MIT license. See LICENSE file for more details.