Site settings
The front matter of docs/README.md sets up the whole site:
---
name: My Project
home: ../
repository: https://github.com/me/project
address: https://me.github.io/project/
---
The links of the header and the footer belong to a template.
Name and repository
name shows in the browser tab and in llms.txt. It defaults to the last part of the repository URL.
repository is the URL of your repository. It defaults to the URL of the Git remote origin. If your repository isn't on GitHub, set host too.
Releases
releases turns on releases from Git tags. Its from is the oldest version that the site shows, as v1.2, and each later minor version with a tag is a release too. Its optional prefix selects tags such as api/v1.2.0. See Versions.
Logo and favicon
Put logo.svg in the docs folder to show it in place of the name. The logo leads to the first page, or to home: a URL relative to the output folder, as ../ for a landing page above the docs.
favicon.svg, favicon.png or favicon.ico becomes the icon of the browser tab.
Address
address is the URL of the output folder once deployed, as https://me.github.io/project/. With it, the build writes sitemap.xml and 404.html into the output folder, and the canonical link and the og:url of each page are absolute. Without it, the canonical links are relative, and the build writes neither file.
Search engines read sitemap.xml once you submit it, as in Google Search Console. GitHub Pages shows 404.html for a page that doesn't exist, if the output folder is the root of the site. Below a landing page, the 404 page of the landing page applies.