UNPKG

create-vue-docs-ui

Version:

Scaffolding tool for Vue Docs UI projects - Create beautiful documentation websites with one command

77 lines (57 loc) 2.49 kB
# 介绍 Vue Docs UI 是一个专为现代化文档网站设计的 Vue 3 组件库。它提供了开箱即用的解决方案,让您能够快速构建美观、功能丰富的文档网站。 ## ✨ 为什么选择 Vue Docs UI? ### 🚀 极简上手 只需要 3 行代码就能启动一个完整的文档网站: ```javascript import { createDocsApp } from 'vue-docs-ui' import 'vue-docs-ui/dist/vue-docs-ui.css' createDocsApp({ configPath: '/config/site.yaml', el: '#app' }) ``` ### 🎨 现代化设计 - **优雅界面** - 精心设计的用户界面 - **暗色主题** - 支持明暗主题自动切换 - **响应式布局** - 完美适配各种设备尺寸 - **平滑动画** - 流畅的交互体验 ### 🌐 国际化支持 - **多语言** - 内置中英文支持,易于扩展 - **智能切换** - 自动检测浏览器语言 - **独立配置** - 每种语言独立的配置和内容 ### 🤖 AI 助手集成 - **智能问答** - 基于文档内容的 AI 助手 - **多模型支持** - 支持 OpenAI、Claude、Gemini 等 - **可拖拽界面** - 用户友好的交互设计 ## 🏗️ 核心特性 ### 📝 Markdown 增强 - **语法高亮** - 代码块语法高亮 - **表格支持** - 响应式表格显示 - **图片优化** - 自动图片压缩和懒加载 - **链接检查** - 自动检查死链接 ### 🔍 智能搜索 - **全文搜索** - 快速搜索文档内容 - **模糊匹配** - 智能模糊匹配算法 - **高亮显示** - 搜索结果高亮显示 ### ⚡ 高性能 - **快速构建** - 基于 Vite 的快速构建 - **代码分割** - 智能代码分割优化 - **缓存策略** - 高效的缓存机制 - **SEO 友好** - 搜索引擎优化 ## 🎯 适用场景 Vue Docs UI 适合以下场景: - **技术文档** - API 文档、使用指南 - **产品文档** - 产品说明、用户手册 - **团队知识库** - 内部文档、最佳实践 - **教程网站** - 在线教程、学习资料 - **开源项目** - 项目文档、贡献指南 ## 🔗 生态系统 Vue Docs UI 构建在成熟的技术栈之上: - **Vue 3** - 现代化的 JavaScript 框架 - **Vite** - 下一代前端构建工具 - **TypeScript** - 类型安全的 JavaScript - **YAML** - 人性化的配置格式 - **Markdown** - 简洁的文档编写格式 ## 🚀 开始使用 准备好开始了吗?查看我们的 [安装指南](/guide/installation) 来创建您的第一个文档网站!