Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/retrowin/llms.txt

Use this file to discover all available pages before exploring further.

RetroWin is a fully interactive, Windows 98-style personal portfolio website. It renders a simulated desktop environment in the browser — complete with draggable windows, a Start menu, CRT scanline effects, and retro pixel fonts. Built with React, React Router v6, Framer Motion, and Tailwind CSS, it’s designed to be cloned, customized, and deployed to GitHub Pages with minimal setup.

Introduction

Learn what RetroWin is, what’s included, and how the pieces fit together.

Quickstart

Clone, install, and run RetroWin locally in under five minutes.

Components

Explore all eight Y2K-themed React components and their props.

Customization

Customize the color palette, fonts, and content to make it your own.

What’s inside

RetroWin ships with eight reusable Y2K-themed React components and four pre-built portfolio pages, all wired together with client-side routing.

RetroWindow

Draggable, maximizable window shell with title bar and address bar.

Taskbar

Fixed bottom bar with Start menu, page navigation, and live clock.

DesktopIcon

Double-clickable desktop icon that navigates to a route.

CRTOverlay

Full-screen scanline and flicker effect with reduced-motion support.

Marquee

Horizontally scrolling retro text banner.

HitCounter

localStorage-backed visitor counter with LCD-style digits.

Mascot

Animated chatbot mascot with randomized Y2K speech bubbles.

Webring

Y2K-style developer webring with Previous, Random, and Next links.

Get started in minutes

1

Clone the repository

git clone https://github.com/apursley2012/retrowin.git
cd retrowin
2

Install dependencies

npm install
3

Start the dev server

npm run dev
Open http://localhost:5173 to see your retro desktop.
4

Customize and deploy

Edit the page components in src/, update your content, then deploy to GitHub Pages with npm run build.

Build docs developers (and LLMs) love