Skip to main content

The DEEP Build Kit · Card 17

Ship It: Publish on GitHub Pages

Know exactly what is public, then publish your single-file tool on GitHub Pages using only a web browser, update it safely, and take it down.

For: The Level 3 ■ stretch; Level 2 ▲ on request

Card 17 · The Level 3 ■ Black stretch (Level 2 ▲ Orange on request) · 20 minutes

GitHub Pages turns a file into a live web page, free, for public repositories. Everything below happens in your browser and your file manager: no installs, no terminal. Working in Claude Code or Codex? Upload the index.html from your project folder in the same way.

Checked against GitHub's documentation on 8 Oct 2026. Buttons move: trust your screen.

Before the day

  1. Create a free account at github.com. Pick a username you are happy to see in a public web address: it appears in your site's address.
  2. Verify your email address from the message GitHub sends you.

What is public: read this before you upload

Step 0: check the file before it goes anywhere. No names: nothing about a real student. No keys: no passwords or API keys. No logo: no school logo without the school's permission.

  • A public repository is public. Anyone can see your files and every earlier version. Deleting a file later does not remove it from the history.
  • The Pages site is public, even on a plan that lets you publish from a private repository.
  • People can find it. Search engines can find a Pages site, and anyone can find its repository through your GitHub profile.
  • So never put personal data in a repository: no names, photos, marks, email addresses or anything about a real student, in a file, a file name or a commit message. No passwords or keys, ever.
  • Selling a tool? GitHub's rules say Pages must not be used for e-commerce or commercial software-as-a-service. Check GitHub's terms before selling anything.

Before you share, say it out loud: who can see the page, who can see the files, and who can see the history.

Publish

  1. Name your file index.html, exactly, so it opens at the site's main address. Turn on file extensions first, so you see the real name. On Windows 11, in File Explorer, choose View, then Show, then File name extensions. On a Mac, in Finder, choose Finder, then Settings, then Advanced, and tick Show all filename extensions. The name must be index.html, not index.html.html.
  2. Create a new repository. A repository is the project folder, with its full history. Click + at the top right of any GitHub page, then New repository. Give it a short name, such as particles-quiz, and choose Public: on a free account, Pages publishes only from public repositories. Turn Add README on, so the repository is not empty, then click Create repository.
  3. Upload the file. On the repository's main page, above the list of files, choose Add file, then Upload files. Drag in index.html.
  4. Commit. In the commit message box, say what this version is, such as "Version 1, after partner test". Choose to commit directly to the main branch, then confirm. A commit is a saved, labelled version.
  5. Switch on Pages. Go to Settings, then Pages. Under Build and deployment, set the source to Deploy from a branch. Choose the main branch and the /(root) folder, then Save.
  6. Wait up to 10 minutes, reloading the Pages settings until your site's address appears with Visit site. It looks like https://[username].github.io/[repository-name]/.
  7. Visit it on a laptop and on a phone. Re-run three of your success checks on the live link. Send the link to your test partner.

Update it

  1. Fix your file and save the new version on your laptop (card 06).
  2. Upload it again under the same name, index.html, and commit with a message that says what changed. Then open index.html in the repository and check your change is there.
  3. Wait up to 10 minutes. Then reload the live page with a hard refresh, so your browser fetches the new version, not the copy it saved earlier (in Chrome: Ctrl+Shift+R, or Cmd+Shift+R on a Mac). Re-run your success checks.

Take it down

  • To take the site offline: on the repository's main page, next to Your site is live at, click ⋯, then Unpublish site. Your files stay in the repository.
  • To remove the site and the files: delete the repository. Go to Settings, scroll down the General page to Danger Zone, click Delete this repository and follow the steps. Copies other people made of a public repository (forks) are not deleted.
  • Leaked a key? First cancel the key with the provider that issued it, then delete the repository. Deleting the file is not enough: it stays in the history.

If github.com is blocked on your network, share the .html file today (card 09), run the keyboard and contrast audit (card 08) as your stretch instead, and publish from home.

DEEP Education Network · Build with AI · Two rules: no student names or data anywhere; nothing student-facing calls AI.