UNPKG

create-vue-docs-ui

Version:

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

50 lines (31 loc) 1.74 kB
# Introduction Welcome to **Vue Docs UI** - the simplest way to create beautiful documentation websites with Vue.js! ## What is Vue Docs UI? Vue Docs UI is a modern, lightweight, and highly customizable documentation framework built with Vue 3 and TypeScript. It helps you create professional documentation websites with minimal setup and maximum flexibility. ## Key Features ### 🚀 **Quick Setup** Get started in minutes with zero configuration required. ### 📱 **Responsive Design** Looks great on all devices - from mobile phones to desktop computers. ### 🎨 **Customizable Themes** Built-in light and dark themes with full customization support. ### 📝 **Markdown Support** Write your documentation in Markdown with enhanced features. ### 🔍 **Built-in Search** Powerful search functionality to help users find content quickly. ### ⚡ **Lightning Fast** Built with Vite for incredibly fast development and build times. ## Why Vue Docs UI? - **Developer Friendly**: Simple API and intuitive configuration - **Production Ready**: Optimized for performance and SEO - **Extensible**: Easy to customize and extend with your own components - **Modern**: Built with the latest Vue 3 and TypeScript technologies ## Getting Started Ready to create your first documentation website? Check out our [Installation Guide](/guide/installation) to get started in just a few minutes! ## Community Join our growing community: - 🐛 [Report Issues](https://github.com/shenjianZ/vue-docs-ui/issues) - 💡 [Feature Requests](https://github.com/shenjianZ/vue-docs-ui/discussions) - 📖 [Documentation](https://github.com/shenjianZ/vue-docs-ui) --- *Happy documenting! 📚*