Skip to content

Add VitePress docs site with animated landing page#13

Open
Robert27 wants to merge 4 commits into
mainfrom
cursor/docs-landing-vitepress-edd1
Open

Add VitePress docs site with animated landing page#13
Robert27 wants to merge 4 commits into
mainfrom
cursor/docs-landing-vitepress-edd1

Conversation

@Robert27

@Robert27 Robert27 commented Jun 20, 2026

Copy link
Copy Markdown
Owner

Summary

Adds a static documentation site powered by VitePress (Vite-based) with a custom animated landing page and full command reference for the eggl CLI.

Landing page

  • Custom HomeHero Vue component with gradient mesh background, floating orbs, and mouse-reactive glow
  • Animated terminal demo with typing effect cycling through doctor, env toggle, and pf commands
  • Staggered fade-in animations, shimmer gradient headline, and hoverable command cards
  • eggl brand colors (#F97316 accent) matching the CLI's lipgloss theme

Documentation

  • Guide: getting started, installation, configuration, shell completion
  • Commands: full reference for all 10 commands with flags, examples, and behavior notes
  • Imprint: legal notice page at /imprint
  • Local search, dark theme (with working light/dark toggle), sidebar navigation

Tooling

  • make docs-dev — local dev server
  • make docs-build — production static build
  • GitHub Actions workflow to build and deploy to GitHub Pages on push to main

Local development

make docs-dev
# open http://localhost:5173

Deploy note

After merge, enable GitHub Pages in repo settings with source GitHub Actions. The site will be available at https://robert27.github.io/eggl-cli/.

Open in Web Open in Cursor 

- Scaffold docs/ with VitePress (Vite-based static site generator)
- Custom HomeHero component with gradient mesh, terminal typing animation,
  command cards, and eggl brand colors (#F97316)
- Full command reference for all CLI commands plus guide pages
- Makefile targets: docs-install, docs-dev, docs-build, docs-preview
- GitHub Actions workflow to build and deploy to GitHub Pages

Co-authored-by: Robert Eggl <robert@eggl.dev>
@codecov

codecov Bot commented Jun 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

cursoragent and others added 3 commits June 20, 2026 20:52
- Replace hardcoded dark navbar background with theme-aware
  color-mix using --vp-c-bg so light/dark mode toggle works
- Add /imprint legal notice page (TMG/RStV) with maintainer info
- Link imprint from VitePress footer and landing page footer

Co-authored-by: Robert Eggl <robert@eggl.dev>
- Introduce SiteFooter component via layout-bottom slot on all pages
- Replace per-page VitePress footer and landing-only footer with unified
  footer (MIT License, copyright, Imprint, GitHub)
- Center the 'Ready to simplify your workflow?' CTA section on landing

Co-authored-by: Robert Eggl <robert@eggl.dev>
- Particle field canvas with mouse-reactive nodes and connections
- Aurora ribbons, drifting grid, noise texture, cursor spotlight
- Floating command chips, infinite marquee, stats row
- Staggered word-by-word title reveal with shimmer accents
- 3D tilt terminal with scanlines, glow pulse, and live badge
- Scroll-triggered reveals via IntersectionObserver
- Per-command colored card glows with spring hover animations
- Spinning conic-gradient border on CTA section
- Working copy button, reduced-motion support

Co-authored-by: Robert Eggl <robert@eggl.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants