Skip to content

DocMaster is a responsive web template designed specifically for creating professional and user-friendly documentation sites. It provides an easy-to-customize structure with sections for guides, API references, helping developers and teams publish clear and well-organized docs quickly. Built with modern HTML, CSS, and JavaScript

License

Notifications You must be signed in to change notification settings

renzorlive/docmaster

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š VimMaster Documentation

A modern, responsive documentation website for VimMaster - the interactive Vim learning game. Built with cutting-edge 2025 design trends including glassmorphism, floating animations, and mobile-first responsive design.

✨ Features

🎨 Modern Design System

  • Glassmorphism UI with advanced backdrop filters
  • Floating animations with staggered timing
  • Enhanced shadows and gradient overlays
  • Fully responsive design optimized for all devices (320px+)
  • 3D transforms and morphing shapes
  • Holographic text effects and neon glows

πŸ”§ Advanced Components

  • Enhanced Command Palette (Ctrl+K) with fuzzy search, keyboard navigation, categories, and recent commands
  • Mobile-optimized navigation with glassmorphic menu
  • Dynamic social proof with animated counters
  • Toast notifications system
  • Responsive tables and code blocks
  • Touch-friendly interface with proper tap targets

⚑ Performance & SEO

  • Vanilla JavaScript - No frameworks, lightning fast
  • Mobile-first responsive design - Works on all screen sizes
  • SEO optimized with proper meta tags
  • Accessibility compliant (WCAG 2.1)
  • Font preloading and performance optimizations

🎯 Interactive Elements

  • Skill bars with shimmer animations
  • Hover transformations with scale and glow effects
  • Smooth scrolling and intersection observers
  • Theme switching (light/dark mode)
  • Mobile gesture support for enhanced UX

πŸš€ Quick Start

# Clone the repository
git clone https://github.com/renzorlive/vimmaster.git
cd vimmaster/docs

# Serve locally
python -m http.server 8000
# or
npx serve .

# Visit http://localhost:8000

πŸ“ Project Structure

β”œβ”€β”€ index.html          # Homepage with hero and features
β”œβ”€β”€ levels.html         # Levels/guides page
β”œβ”€β”€ commands.html       # Commands/reference page  
β”œβ”€β”€ api.html           # API documentation
β”œβ”€β”€ features.html      # Features showcase
β”œβ”€β”€ mobile-test.html   # Mobile responsiveness test page
β”œβ”€β”€ css/
β”‚   └── main.css       # Modern CSS with responsive design system
β”œβ”€β”€ js/
β”‚   β”œβ”€β”€ main.js        # Interactive components
β”‚   └── advanced.js    # Advanced features
β”œβ”€β”€ img/               # SVG icons and assets
β”œβ”€β”€ components/        # Reusable HTML components
β”œβ”€β”€ api/
β”‚   └── stats.js       # Dynamic stats API endpoint
β”œβ”€β”€ favicon.svg        # Custom VIM favicon
└── manifest.json      # PWA manifest

🎨 Design System

Colors

--primary: #22c55e;     /* VimMaster green */
--secondary: #3b82f6;   /* Blue accent */
--bg: #ffffff;          /* Light background */
--text: #111827;        /* Dark text */

Mobile-First Components

  • Cards: Glassmorphism with floating animations, fully responsive
  • Buttons: Touch-friendly with 44px+ tap targets
  • Stats: Animated counters that adapt to mobile layout
  • Code blocks: Horizontal scroll on mobile, syntax highlighting
  • Navigation: Collapsible mobile menu with glassmorphic design
  • Command Palette: Fully responsive with touch optimization

πŸ“± Mobile Responsiveness

Breakpoints Covered

  • 320px+: Very small phones (iPhone SE)
  • 480px+: Small phones
  • 640px+: Large phones
  • 768px+: Tablets
  • 1024px+: Desktop

Mobile Optimizations

  • Touch targets: All interactive elements meet 44px minimum
  • Responsive grids: Single column on mobile, multi-column on larger screens
  • Mobile menu: Glassmorphic slide-out navigation
  • Optimized typography: Scales appropriately across all screen sizes
  • Horizontal scroll: Tables and code blocks scroll horizontally on mobile
  • Reduced animations: Respects prefers-reduced-motion

πŸ”§ Customization

1. Update Branding

<!-- Change logo and title in index.html -->
<div class="logo-icon">VIM</div>
<h1 class="hero-title">VimMaster Documentation</h1>

2. Modify Colors

/* Update CSS variables in main.css */
:root {
    --primary: #22c55e;
    --secondary: #3b82f6;
}

3. Test Mobile Responsiveness

  • Open mobile-test.html to test all components
  • Real-time breakpoint display
  • Test all interactive elements

🌟 Key Features Breakdown

Enhanced Command Palette

// Advanced fuzzy search with scoring
fuzzySearch(query) {
    return this.commands
        .map(cmd => ({ ...cmd, score: this.calculateScore(cmd, query) }))
        .filter(cmd => cmd.score > 0)
        .sort((a, b) => b.score - a.score);
}

Keyboard Navigation

// Arrow key navigation with visual feedback
handleKeyNavigation(e) {
    if (e.key === 'ArrowDown') {
        this.selectedIndex = Math.min(this.selectedIndex + 1, items.length - 1);
        this.updateSelection(items);
    }
}

Recent Commands

// Persistent recent commands storage
addToRecent(commandName) {
    this.recentCommands.unshift(commandName);
    this.recentCommands = this.recentCommands.slice(0, 5);
    localStorage.setItem('recent-commands', JSON.stringify(this.recentCommands));
}

πŸ”₯ Advanced Features

Gesture Controls

// Swipe gestures for mobile
handleGesture(startX, startY, endX, endY) {
    const deltaX = endX - startX;
    if (deltaX > 100) {
        new CommandPalette().open(); // Swipe right
    }
}

Particle System

// Dynamic particle animations
animate() {
    this.particles.forEach(particle => {
        particle.x += particle.vx;
        particle.y += particle.vy;
        this.ctx.arc(particle.x, particle.y, particle.size, 0, Math.PI * 2);
    });
}

🌟 Additional Features

Glassmorphism Cards

background: linear-gradient(135deg, rgba(255, 255, 255, 0.1), rgba(255, 255, 255, 0.05));
backdrop-filter: blur(20px) saturate(180%);
border: 1px solid rgba(255, 255, 255, 0.18);

Floating Animations

@keyframes float {
    0%, 100% { transform: translateY(0px); }
    50% { transform: translateY(-8px); }
}

Interactive Hover Effects

.card:hover {
    transform: translateY(-4px) scale(1.02);
    box-shadow: 0 20px 60px rgba(0, 0, 0, 0.2);
}

πŸ“± Responsive Design

  • Mobile-first approach
  • Flexible grid system
  • Touch-friendly interactions
  • Optimized animations for mobile

πŸ” SEO & Performance

Meta Tags

  • Open Graph for social sharing
  • Twitter Cards support
  • JSON-LD structured data
  • Proper meta descriptions

Performance

  • Font preloading
  • Optimized images
  • Minimal JavaScript
  • CSS custom properties

🎯 Use Cases

Perfect for:

  • Documentation sites
  • Product landing pages
  • Developer portfolios
  • SaaS marketing sites
  • API documentation
  • Component libraries

πŸ›  Browser Support

  • Chrome 90+ βœ…
  • Firefox 88+ βœ…
  • Safari 14+ βœ…
  • Edge 90+ βœ…
  • Mobile browsers βœ…
  • Touch devices βœ…

πŸ“„ License

MIT License - feel free to use for personal and commercial projects.

🀝 Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

πŸŽ‰ Credits

Built with modern web technologies:

  • CSS Grid & Flexbox for responsive layouts
  • CSS Custom Properties for theming
  • Intersection Observer for animations
  • Backdrop Filter for glassmorphism
  • Mobile-first responsive design
  • Vanilla JavaScript for performance

πŸš€ Live Demo

Visit the live documentation: VimMaster Docs


Made with ❀️ for the VimMaster and OpenSource community

Modern, responsive documentation for the interactive Vim learning experience

About

DocMaster is a responsive web template designed specifically for creating professional and user-friendly documentation sites. It provides an easy-to-customize structure with sections for guides, API references, helping developers and teams publish clear and well-organized docs quickly. Built with modern HTML, CSS, and JavaScript

Resources

License

Stars

Watchers

Forks