UNPKG

create-vue-docs-ui

Version:

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

58 lines (42 loc) 1.76 kB
# Welcome to Vue Docs UI Vue Docs UI is a modern documentation website builder based on Vue 3, providing an out-of-the-box documentation solution. ## 🌟 Key Features - **🚀 Ready to Use** - Launch your documentation website with just 3 lines of code - **🎨 Modern Design** - Beautiful interface design with light/dark theme support - **📱 Mobile Responsive** - Perfect responsive design - **🌐 Internationalization** - Built-in multi-language support - **🤖 AI Assistant** - Integrated AI chat assistant with multiple model support - **⚡ High Performance** - Built with Vite for fast hot reload - **🔍 Full-text Search** - Smart search functionality - **📝 Enhanced Markdown** - Rich Markdown extensions ## 🏗️ Architecture Features - **Component-based Design** - Modular components, easy to extend - **TypeScript Support** - Complete type support - **Customizable Themes** - Flexible theme configuration - **Plugin System** - Extensible plugin architecture ## 📦 Quick Start ```bash # Create new project npm create vue-docs-ui@latest my-docs # Navigate to project directory cd my-docs # Install dependencies npm install # Start development server npm run dev ``` ## 📖 Usage ```javascript import { createDocsApp } from 'vue-docs-ui' import 'vue-docs-ui/dist/vue-docs-ui.css' createDocsApp({ configPath: '/config/site.yaml', el: '#app' }) ``` It's that simple! No complex configuration needed, get a fully functional documentation website immediately. ## 🔗 Related Links - [GitHub Repository](https://github.com/shenjianZ/vue-docs-ui) - [Online Demo](https://vue-docs-ui.example.com) - [User Guide](/guide/introduction) - [API Documentation](/advanced/api)