Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/aurora-cosmos/llms.txt

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

Aurora Cosmos is distributed as a pre-built static output. The repository you received is not a source project that needs to be compiled — it is already the finished, optimized result of a Vite production build. You can serve it directly from any static hosting provider or local file server without running any build commands.

​
Repository structure

The repository root is the deployment-ready output. Every file needed to run the site is already present: 
aurora-cosmos/
├── index.html                  # Root entry point
├── pages/
│   ├── Home.html
│   ├── About.html
│   ├── Projects.html
│   ├── Skills.html
│   ├── Writing.html
│   ├── CaseStudies.html
│   └── Contact.html
├── assets/
│   ├── main.js                 # Bundled React + Framer Motion app
│   ├── main.css                # Compiled Tailwind CSS
│   └── proxy.js                # Shared dependencies bundle
├── components/
│   ├── AuroraBackground.js     # Aurora gradient animation module
│   ├── Navigation.js           # Site navigation module
│   └── Starfield.js            # Starfield parallax module
├── useScreenInit.js            # Screen initialization hook
├── canvas.manifest.js          # Asset manifest
└── .nojekyll                   # Prevents GitHub Pages Jekyll processing
There is no src/ directory, no tailwind.config.js, no vite.config.js, and no package.json — those belong to the original source project and are not part of the compiled output.

​
Serving the site locally

Because the output is plain static HTML, CSS, and JavaScript, you can preview it with any local HTTP server. Browsers block certain features (like ES module imports) on file:// URLs, so use a server rather than opening index.html directly. 
# Serve the repo root on port 8000
python3 -m http.server 8000
Open http://localhost:8000 (or whichever port your server uses) to browse the site.

​
How routing works

Each file in pages/ is a thin HTML shell that sets window.__STATIC_PAGE_ROUTE__ to its corresponding path. When a visitor lands on /pages/About.html directly, the script reads the route and hands control to the React app, which renders the correct view using hash-based navigation (#/about). Because all navigation is hash-based, every URL resolves to the same index.html from the server’s perspective. No rewrite rules, _redirects files, or server configuration are required — the static output works out of the box on every hosting platform.

​
The .nojekyll file

The repository includes a .nojekyll file at its root. This empty file tells GitHub Pages to skip its default Jekyll processing pipeline. Without it, GitHub Pages would silently ignore any file or directory whose name begins with an underscore — which would prevent JavaScript modules and other underscore-prefixed assets from being served. The .nojekyll file is harmless on all other hosts.

​
Customizing without rebuilding

You can make the following changes directly to the compiled output without any build tooling:
  • Colors — edit hex values in assets/main.css (see the Colors guide)
  • Typography — update the @import URL and font-family values in assets/main.css (see the Typography guide)
  • Animations — edit keyframe values and motion props in components/AuroraBackground.js and components/Starfield.js, and @keyframes durations in assets/main.css (see the Animations guide)
  • Content — edit text and markup directly in pages/*.html and index.html

​
Rebuilding from the original source

If you need to make structural changes — new pages, new components, dependency upgrades, or changes to the Tailwind configuration — you would need the original Vite source project, which contains the src/ directory, tailwind.config.js, vite.config.js, and package.json. After making changes to the source, run the Vite production build to regenerate the compiled output: 
npm run build
The build output is then written to a dist/ directory, which mirrors the structure of this repository’s root. Deploy that dist/ folder in place of the current repo contents.
The original source project is separate from this compiled distribution. If you received only the compiled output and need the source, contact the template author or check the original repository for a source branch or separate source archive.

Build docs developers (and LLMs) love

Get started for freeTalk to us