Overview

The Vmi is a plugin collection for VuePress, designed for component development scenarios. It aims to provide a similar demo experience to Dumi while retaining the powerful documentation writing capabilities of VuePress. It features a powerful demo display ability with support for multiple display modes. It also supports page path mapping and customization of component documentation organization. Additionally, it supports translation for missing content and generates pages for missing languages. The theme’s style layout is synchronized, although it is still in the process of improvement.

Features

• Demo Display: Powerful demo display capability with support for multiple display modes.
• Page Path Mapping: Ability to map page paths and customize component documentation organization.
• Translation Support: Automatically generates pages for missing languages and supports translation for missing content.
• Theme Style Layout: Provides synchronized style layout (work in progress).

Installation

To install Vmi, you need to have VuePress v2.0.0-beta.60 installed. Once you have VuePress installed, you can follow these steps:

1. Add Vmi as a dev dependency to your project:

npm install -D vmi

2. Create a .vuepress/vmi.js file with the following content:

module.exports = {
  plugins: ['vmi'],
}

3. In your .vuepress/config.js file, enable the Vmi plugin:

module.exports = {
  plugins: [
    'vmi'
  ]
}

4. That’s it! You have successfully installed Vmi for your VuePress project.

Summary

Vmi is a plugin collection for VuePress, specifically designed for component development scenarios. It enhances the demo display capabilities of VuePress while maintaining its powerful documentation writing features. With support for various display modes, page path mapping, translation, and synchronized theme style layout, Vmi provides a comprehensive solution for component documentation.