Skip to main content

Documentation Index

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

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

y2k-web is a pure static site — there are no API backends, no environment variables, and no server-side logic required. Because the router uses hash-based navigation (#/route), the browser handles all route resolution entirely on the client side. This means every static hosting provider works out of the box, with no special redirect rules or server configuration needed.
GitHub Pages serves static files directly from your repository — it’s free for public repos and requires no external tooling.The y2k-web repo already includes a .nojekyll file in the root, which tells GitHub Pages to skip Jekyll processing and serve all files as plain static assets. Because the compiled assets (assets/main.js, assets/main.css, components/Primitives.js, components/Guestbook.js) are committed directly to the repository, you can deploy straight from the repo root without running a build step.
1

Push your repo to GitHub

Make sure your latest code is pushed to the main branch on GitHub.
2

Open repository Settings

Navigate to your repository on GitHub and click the Settings tab.
3

Configure Pages source

In the left sidebar, click Pages. Under Source, select Deploy from a branch.
4

Select branch and folder

Choose the main branch and the / (root) folder, then click Save.
5

Visit your live site

After a short build delay, your site will be live at:
https://<username>.github.io/<repo-name>/
GitHub Actions workflow (automated builds)If you have made source changes and want GitHub Actions to rebuild the assets and publish the compiled output automatically on every push, create .github/workflows/deploy.yml in your repository:
name: Deploy to GitHub Pages
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm install && npm run build
      - uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./dist
This workflow installs dependencies, runs the Vite build, and publishes the dist/ directory to the gh-pages branch on every push to main.

Custom domain

All three platforms — GitHub Pages, Netlify, and Vercel — support custom domains at no additional cost. To connect your own domain, point the domain’s DNS either to the platform’s IP address via an A record or to the platform’s hostname via a CNAME record (consult each platform’s DNS documentation for the exact values). Then add and verify the domain inside the platform’s dashboard. TLS certificates are provisioned automatically.
Because y2k-web uses hash-based routing, all internal links use the #/path format (e.g., /#/about, /#/projects). If a visitor navigates directly to a path like /about — without the hash — the hosting provider will return a 404, because that path doesn’t correspond to a real file. The hash form /#/about will always work on any static host without any additional server configuration.

Build docs developers (and LLMs) love