Git Product home page Git Product logo

vite-plugin-vue-docs's Introduction

vite-plugin-vue-docs

npm version license jest coverage

vite plugin-automatically generate vue component documentation

中文文档

preview

Features

  • Support hot update
  • Quick start, rely on vite, no need to start another service
  • Automatically generated component navigation
  • ui adopts the style of vant-ui
  • Core method coverage reached 92.86%

Use

yarn add vite-plugin-vue-docs -D
// vite.config.js

import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import vueDocs from "vite-plugin-vue-docs";

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [vue(), vueDocs()],
});

example

git clone https://github.com/meetqy/vite-plugin-vue-docs.git
yarn
yarn dev
yarn example:dev

Plan

  • 🚀 means functions that have been implemented
  • 👷 means functions in progress
  • ⏳ means functions in planning
Features Status
Packaged into a static web page ⏳ Planning
Page jump history mode || hash mode ⏳ Planning
Configurable document website ⏳ Planning
Modified files are directly hot-updated without F5 refresh ⏳ Planning
Support parsing ref 👷 Progress
Support parsing slot 👷 Progress
Support defineComponent() writing method 🚀 Completed
Support type multiple types 🚀 Completed
Automatically generate routing 🚀 Completed

changlog

Version log

vite-plugin-vue-docs's People

Contributors

meetqy avatar github-actions[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.