1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/meetqy-vite-plugin-vue-docs

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
README.md 5.8 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 30.11.2024 11:54 7bf002d

vite-plugin-vue-docs

npm version license Statements example deploy

Введение

vite 插件 — автоматически генерирует сайт документации для компонентов Vue. Онлайн-демонстрация.

English | 中文

preview

Особенности

  • Поддержка горячего обновления.
  • Быстрый запуск, зависит от vite, не требует запуска отдельного сервера.
  • Автоматическое создание навигационного меню по компонентам.
  • Онлайн-просмотр демо.
  • UI использует стили vant-ui.
  • Покрытие кода основных методов составляет 92,86%.

Запуск примера

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

Использование

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";

export default defineConfig({
  plugins: [vue(), vueDocs()],
  resolve: {
    alias: {
      // Необходимо добавить эту строку, иначе невозможно использовать
      vue: "vue/dist/vue.esm-bundler.js",
    },
  },
});

Изменение main.{ts|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 🚀 Реализовано
Разбор слота 🚀 Реализовано
Анализ реф 🚀 Реализовано
Поддержка различных типов 🚀 Реализовано
Автоматическая генерация маршрутов 🚀 Реализовано

CHANGELOG

Журнал изменений.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/meetqy-vite-plugin-vue-docs.git
git@api.gitlife.ru:oschina-mirror/meetqy-vite-plugin-vue-docs.git
oschina-mirror
meetqy-vite-plugin-vue-docs
meetqy-vite-plugin-vue-docs
devlop