Publish a project site with GitHub Pages

A repository can also publish static documentation, a portfolio or a project site. GitHub Pages is useful when your output is HTML, CSS, JavaScript and other static assets.

GitHub Pages can publish from a branch/folder or through a GitHub Actions workflow, depending on repository configuration. It is static hosting: there is no general-purpose server process running your backend code.

Keep source and generated output responsibilities clear. For documentation sites, automate builds so published content is reproducible rather than manually edited in the deployed output.

Run this in a disposable practice repository unless the lesson explicitly says otherwise.

mkdir -p docs
printf "<h1>Notes App</h1>\n<p>Project documentation.</p>\n" > docs/index.html
git add docs/index.html
git commit -m "Add project site"
git push

After committing the files, configure Pages in the repository settings for the appropriate publishing source. Exact options depend on the repository and account settings.

Your task: Create an index.html with a project title, README link and release link. Explain which parts are static and which would require a separate backend service.

Do not publish private credentials or internal data in Pages content. A repository's visibility and Pages exposure rules depend on account/plan configuration; verify the final published site directly.

Publish a project site with GitHub Pages is complete when you can explain the state being changed before you run the command, not merely repeat the syntax.

Read further: official supporting documentation.