diff --git a/docs/publish/gh-pages.md b/docs/publish/gh-pages.md index 13ec15f5ef73406c1c3d856a5216f49bd560f4ca..72f05f86bf72f451e93c252a4e188f47f3b7d341 100644 --- a/docs/publish/gh-pages.md +++ b/docs/publish/gh-pages.md @@ -184,6 +184,17 @@ jobs: If you want to deploy your site to GitHub Pages at a User and Organization repository (`<username>.github.io`), check another example workflow and available options at the README of [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages). + +### GitHub Pages Configuration + +The settings for GitHub Pages must be configured to reflect the method used to build the docs. +Access a project's Pages settings at `Settings` -> `Pages`. +Set `Source` to `Deploy from a branch` and set `Branch` to `gh-pages`. +The build location should be `/ (root)` for each of the methods described here. +However, you may choose to place the build files in `/docs` and configure Pages accordingly. + + + ## Use a custom domain with GitHub Pages By default, GitHub Pages will host your book at a URL like `githubusername.github.io/yourbookname`.