Website

This website is built using Docusaurus, a modern static website generator.

Installation

npm install

Note: feel free to use the package manager of your choice.

Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

This site deploys to GitHub Pages via GitHub Actions, using the modern artifact-based Pages deployment — not the older gh-pages branch approach, and not the npm run deploy script above (that script only knows how to push to a gh-pages branch, so it isn't used here).

On every push to main:

1. A workflow (.github/workflows/deploy.yml) runs npm ci && npm run build.
2. The build/ output is uploaded as a Pages artifact via actions/upload-pages-artifact.
3. actions/deploy-pages publishes that artifact directly to GitHub Pages.

No gh-pages branch exists, and build/ is never committed anywhere — not on main, not on any other branch. It's a .gitignored, CI-only artifact, generated fresh on every deploy.

One-time repo setup (done once in GitHub, not via a local command): in the repo's Settings → Pages → Build and deployment, the source must be set to "GitHub Actions" (not "Deploy from a branch"). Without this, actions/deploy-pages has nothing to publish to.

Custom domain: the site's CNAME file (www.kiit.dev) lives in static/CNAME, so Docusaurus copies it into build/CNAME automatically as part of every build, and it gets published to Pages along with everything else — no separate step needed.

Status: the workflow file and the CNAME move into static/ are both done. The one remaining step is the repo's Pages source setting (Settings → Pages → Build and deployment → Source: "GitHub Actions"), which has to be set by hand in GitHub — it can't be done from a workflow file.