vite 插件 — автоматически генерирует сайт документации для компонентов Vue. Онлайн-демонстрация.
English | 中文
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";
// Импорт виртуального пакета
import { routes, initVueDocsDemo } from "virtual:vite-plugin-vue-docs";
const router = createRouter({
// ...
routes,
});
// Импортируем демо-компонент
app.use(initVueDocsDemo);
// vite-env.d.ts
/// <reference types="vite-plugin-vue-docs/client" />
Более подробную информацию о применении можно найти в @vue-docs/example.
Параметр | Описание | Значение по умолчанию |
---|---|---|
base | Адрес маршрута документов | /docs |
componentDir | Путь к компонентам относительно src | /components |
vueRoute | Имя экземпляра маршрутизатора | router |
showUse | Отображение руководства по использованию на статическом сайте | true |
header | Конфигурация заголовка | - |
Параметр | Описание | Значение по умолчанию |
---|---|---|
title | Заголовок сайта | Название проекта |
Функция | Состояние |
---|---|
Настраиваемый сайт документации | ⏳ В разработке |
Совместимость с <script setup>
|
⏳ В разработке |
Совместимость с composition api
|
⏳ В разработке |
Просмотр исходного кода | 👷 В процессе |
Сборка в статический веб-сайт | 🚀 Реализовано |
Переходы между страницами: история или хеш | 🚀 Реализовано |
Онлайн-демонстрация | 🚀 Реализовано |
Автоматическое обновление при изменении файла без перезагрузки страницы F5 | 🚀 Реализовано |
Разбор слота | 🚀 Реализовано |
Анализ реф | 🚀 Реализовано |
Поддержка различных типов | 🚀 Реализовано |
Автоматическая генерация маршрутов | 🚀 Реализовано |
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )