This directory contains the enhanced documentation for MCP UI, built with VitePress and featuring a professional, modern design.
The documentation has been significantly improved with:
- Modern Color Scheme: Blue to green gradient branding with excellent contrast
- Professional Typography: Inter font family with proper font weights and spacing
- Enhanced Shadows: Subtle depth and visual hierarchy
- Smooth Animations: Fade-in effects and hover transitions
- Responsive Design: Mobile-first approach with breakpoint optimizations
- Video Integration: Demo video from README prominently featured on landing page
- Rich Feature Cards: Six detailed feature cards with icons and descriptions
- Code Examples: Syntax-highlighted examples with proper formatting
- Call-to-Action Buttons: Professional buttons with hover effects
- Better Navigation: Improved sidebar with collapsible sections
- Local Search: Built-in search functionality
- Dark Mode: Full dark mode support with proper color schemes
- SEO Optimization: Meta tags, OpenGraph, and Twitter cards
- Performance: Optimized loading and rendering
- Accessibility: Proper ARIA labels and keyboard navigation
To run the documentation locally:
cd docs
npm install
npm run devTo build for production:
npm run builddocs/
├── src/
│ ├── .vitepress/
│ │ ├── config.ts # VitePress configuration
│ │ └── theme/
│ │ ├── index.ts # Custom theme setup
│ │ └── custom.css # Enhanced styling
│ ├── guide/ # Documentation pages
│ ├── public/ # Static assets
│ │ ├── logo.svg # Brand logo
│ │ └── favicon.png # Site favicon
│ └── index.md # Enhanced landing page
└── README.md # This file
- Hero section with gradient text and compelling tagline
- Demo video integration from the main README
- Six feature cards highlighting key capabilities
- Code examples showing quick usage
- Call-to-action buttons linking to guides and demos
- Clean, organized sidebar with collapsible sections
- Breadcrumb navigation
- "Edit on GitHub" links
- Social media links (GitHub, npm)
- Professional typography with proper hierarchy
- Enhanced code blocks with syntax highlighting
- Improved tables with hover effects
- Styled blockquotes and badges
- Responsive images and media
- Optimized bundle size
- Fast loading times
- Efficient caching
- Mobile-optimized assets
The documentation uses CSS custom properties for easy theming:
:root {
--vp-c-brand-1: #3c82f6; /* Primary brand color */
--vp-c-brand-2: #2563eb; /* Secondary brand color */
--vp-c-accent-1: #10b981; /* Accent color */
/* ... more variables */
}When adding new content:
- Use proper markdown headers (##, ###) for structure
- Include code examples with language tags
- Add screenshots or diagrams where helpful
- Keep paragraphs concise and scannable
- Use callouts for important information
To contribute to the documentation:
- Edit files in the
src/directory - Test locally with
npm run dev - Build with
npm run buildto verify - Submit a pull request
The documentation automatically rebuilds on changes to the main branch.