代码拉取完成,页面将自动刷新
vite 插件 - 自动生成 vue 组件文档网站。 在线体验
English | 中文
Demo
在线查看vant-ui
的样式git clone https://github.com/meetqy/vite-plugin-vue-docs.git
yarn
yarn setup
yarn dev
yarn add vite-plugin-vue-docs -D
import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import vueDocs from "vite-plugin-vue-docs";
export default defineConfig({
plugins: [vue(), vueDocs()],
resolve: {
alias: {
// 必须添加这一行,否则无法使用
vue: "vue/dist/vue.esm-bundler.js",
},
},
});
import { createRouter } from "vue-router";
// 引入虚拟package
import { routes, initVueDocsDemo } from "virtual:vite-plugin-vue-docs";
const router = createRouter({
// ...
routes,
});
// 导入demo组件
app.use(initVueDocsDemo);
// vite-env.d.ts
/// <reference types="vite-plugin-vue-docs/client" />
详细使用方法可参考 @vue-docs/example
参数 | 说明 | 默认值 |
---|---|---|
base | 文档路由地址 | /docs |
componentDir | 组件路径 相对于 src | /components |
vueRoute | router 实例名称 | router |
showUse | 静态网站显示使用指南 | true |
header | 头部配置 | - |
参数 | 说明 | 默认值 |
---|---|---|
title | 网站 header 标题 | 项目名称 |
功能 | 状态 |
---|---|
可配置文档网站 | ⏳ 规划中 |
兼容<script setup> |
⏳ 规划中 |
兼容composition api |
⏳ 规划中 |
可查看源代码 | 👷 进行中 |
打包成静态网页 | 🚀 已完成 |
页面跳转 history 模式 || hash 模式 | 🚀 已完成 |
在线查看实例 | 🚀 已完成 |
修改文件直接热更新,无须 F5 刷新 | 🚀 已完成 |
支持解析slot |
🚀 已完成 |
支持解析ref |
🚀 已完成 |
支持type 多种类型 |
🚀 已完成 |
自动生成路由 | 🚀 已完成 |
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型