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 a pre-built static site with no server requirements. The repository root is the complete deployment-ready output — you push it directly to your hosting provider and it works immediately. No build command, no dependency installation, no configuration files to create. The steps below cover the three most common targets: GitHub Pages, Vercel, and Netlify.
GitHub Pages
Vercel
Netlify
GitHub Pages serves static files directly from a branch in your repository. Because Aurora Cosmos is already compiled, you simply push the repo to a gh-pages branch (or configure Pages to serve from main) and you’re done.Confirm .nojekyll is present
The repository already includes a .nojekyll file at the root. This file prevents GitHub Pages from running Jekyll and ensures all asset files are served correctly. No action needed — it’s already there.
Push your repository to GitHub
Make sure all files are committed and pushed to GitHub. You can push to any branch; the next step lets you choose which one GitHub Pages will serve.
git add .
git commit -m "Deploy Aurora Cosmos"
git push origin main
Enable GitHub Pages in repository settings
Go to your repository on GitHub.
Open Settings → Pages.
Under Source, select Deploy from a branch.
Set the branch to main (or gh-pages if you prefer a dedicated deploy branch) and the folder to / (root).
Click Save.
GitHub will publish the site within a minute. The URL appears at the top of the Pages settings panel.
If your site will live at a subdirectory URL such as username.github.io/aurora-cosmos/, all asset paths in the compiled HTML and CSS must match that base path. The compiled output uses root-relative paths by default (/assets/main.js). For subdirectory deployments, either deploy to a root user page (username.github.io) instead, or manually update the asset paths in index.html and the pages/*.html files to include the subdirectory prefix.
Vercel serves static files with zero configuration. Import the repository, set the output directory to the repo root, and deploy.Push your repository to GitHub
Make sure all files are committed and pushed to GitHub (GitLab and Bitbucket are also supported).
Import the project on Vercel
Go to vercel.com and sign in.
Click Add New → Project.
Select Import Git Repository and choose your Aurora Cosmos repo.
Aurora Cosmos does not need a build step — the files are already compiled. Set the build settings as follows:
| Setting | Value |
|---|
| Framework Preset | Other |
| Build Command | (leave empty) |
| Output Directory | . (repo root) |
| Install Command | (leave empty) |
Click Deploy. Vercel copies the static files and publishes the site in seconds.
main branch (or whichever branch you configured) automatically triggers a new deployment. Pull requests receive their own preview URLs, letting you review changes before merging.Hash-based routing works on Vercel out of the box — no vercel.json rewrite rules are needed. Netlify serves static output directly with no build tooling required.Push your repository to GitHub
Commit and push all files to GitHub (GitLab and Bitbucket are also supported).
Create a new site on Netlify
Go to netlify.com and sign in.
Click Add new site → Import an existing project.
Choose your Git provider and authorize Netlify to access your repositories.
Select your Aurora Cosmos repository.
Enter the following values in the build settings form:
| Setting | Value |
|---|
| Build command | (leave empty) |
| Publish directory | . (repo root) |
Leave all other fields at their defaults.
Click Deploy site. Netlify copies the static files and publishes the site. A generated .netlify.app URL appears in the dashboard once the deploy finishes.
_redirects file or netlify.toml configuration — all navigation happens in the browser after the initial page load. Custom domain
All three platforms support custom domains at no extra cost (beyond what you pay your domain registrar). The general process is the same everywhere:
- Add your domain in the platform’s dashboard (Settings → Domains on Vercel and Netlify; Settings → Pages → Custom domain on GitHub Pages).
- Create a
CNAME record at your DNS provider pointing to the platform-provided hostname (e.g. cname.vercel-dns.com or your-username.github.io).
- Wait for DNS propagation — usually a few minutes to an hour.
- The platform provisions a free TLS certificate automatically once the DNS record resolves.
Refer to each platform’s documentation for the exact DNS values to use.
Because Aurora Cosmos uses hash-based routing (#/route), every URL resolves to the same index.html from the server’s perspective. No rewrite rules, redirect files, or server configuration are needed — the site works out of the box on every static hosting platform.