🚀 Scaffolding tool for Vue Docs UI projects - Create beautiful documentation websites with one command!
Create stunning, responsive documentation websites in minutes with Vue Docs UI. This CLI tool provides everything you need to get started quickly.
# Create a new documentation project
npm create vue-docs-ui my-docs
# Navigate to your project
cd my-docs
# Install dependencies
npm install
# Start the development server
npm run devYour documentation website will be running at http://localhost:5173! 🎉
✨ Zero Configuration - Works out of the box with sensible defaults
📱 Responsive Design - Looks great on all devices
🎨 Customizable Themes - Light and dark themes with full customization
📝 Markdown Support - Write your docs in Markdown with enhanced features
🔍 Built-in Search - Powerful search functionality
⚡ Lightning Fast - Built with Vite for incredible performance
🌍 SEO Optimized - Perfect for public documentation sites
When you run npm create vue-docs-ui, you get a complete documentation website with:
- Modern Vue 3 + TypeScript setup
- Pre-configured routing for seamless navigation
- Responsive layout that works on all devices
- Sample documentation to get you started
- Production-ready build configuration
- Hot reload for fast development
my-docs/
├── public/
│ ├── config/
│ │ └── site.yaml # Site configuration
│ └── docs/
│ ├── guide/
│ │ ├── introduction.md
│ │ ├── installation.md
│ │ └── quick-start.md
│ └── examples/
│ └── basic.md
├── src/
│ ├── App.vue # Main app component
│ └── main.ts # Application entry point
├── index.html
├── package.json
└── vite.config.js
Edit public/config/site.yaml to customize your site:
site:
title: "My Documentation"
description: "My awesome documentation website"
logo: "📚"
author: "Your Name"
navbar:
items:
- title: "Home"
link: "/"
- title: "GitHub"
link: "https://github.com/username/repo"
external: true
theme:
defaultMode: "light"
allowToggle: true
colors:
primary: "#3b82f6"
secondary: "#64748b"Create Markdown files in public/docs/ and they'll automatically be available as pages. Vue Docs UI supports:
- Enhanced Markdown with syntax highlighting
- Tables and lists with beautiful styling
- Code blocks with language-specific highlighting
- Math equations (LaTeX support)
- Custom HTML when needed
# Development
npm run dev # Start development server
# Production
npm run build # Build for production
npm run preview # Preview production build- Node.js 14.18+ or 16+
- npm 6+ or yarn 1.22+
- vue-docs-ui - The underlying documentation framework
- Vue.js - The progressive JavaScript framework
- Vite - Next generation frontend tooling
We welcome contributions! Please see our Contributing Guide for details.
📖 Documentation in multiple languages:
MIT © Vue Docs UI Team
Happy documenting! 📚