Skip to main content

Documentation Index

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

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

Aurora Drift compiles to a dist/ folder of fully static files — plain HTML, CSS, and JavaScript with no server-side runtime required. That output can be dropped onto any static hosting service that can serve files over HTTPS. The sections below cover the three most popular targets: GitHub Pages, Vercel, and Netlify.
The build step (npm run build) requires the original Vite source project. If you are working with the compiled repository directly, the dist/ output already exists as the repository contents — you can deploy those files as-is without running a build. Never commit API keys, access tokens, or any other secrets to the repository.
The Aurora Drift repository includes a .nojekyll file at the root. This file tells GitHub Pages to bypass its default Jekyll processing pipeline and serve all files as-is — including files and directories whose names start with an underscore (such as _assets/). Without .nojekyll, those directories would be silently ignored and the page would fail to load. Make sure this file is present in whatever branch you push to.
1

Build the project

If you have the original Vite source, run:
npm run build
This produces the dist/ folder. Confirm it contains index.html, an assets/ directory, and a pages/ directory. If you are deploying the compiled repository directly, skip this step — the repository root is already the deployable output.
2

Push to the gh-pages branch

The simplest approach is to use the gh-pages npm package:
npx gh-pages -d dist
This command creates (or resets) a gh-pages branch containing only the contents of dist/ and pushes it to GitHub automatically. If you are deploying the compiled repository directly, push the repository root contents instead.
3

Enable Pages in repository settings

Go to your repository on GitHub → Settings → Pages. Under Build and deployment, set the source to Deploy from a branch and select the gh-pages branch, root directory /. Save and wait ~60 seconds for the first deployment to become live.
Subdirectory deployments: If your site will be hosted at https://username.github.io/repo-name/ rather than at a custom domain root, you need to add a base option to vite.config.js in the original source project before building:
// vite.config.js (original source project only)
export default {
  base: '/repo-name/',
}
Rebuild after making this change. Without it, all asset paths will resolve from / and the page will render as a blank white screen. This setting is not available in the compiled repository, which has no vite.config.js.

Further reading

GitHub Pages documentation

Official guide to configuring GitHub Pages, custom domains, HTTPS enforcement, and the gh-pages branch workflow.

Vercel documentation

Vercel’s full docs covering project configuration, environment variables, preview deployments, and custom domain setup.

Build docs developers (and LLMs) love