From 84a1595a8cd5495f192153808a002a7d97c53ddc Mon Sep 17 00:00:00 2001 From: Rafael M Mudafort <rafael.mudafort@nrel.gov> Date: Tue, 15 Nov 2022 03:39:47 -0600 Subject: [PATCH] DOC: Add guidance for configuring gh-pages (#1859) * Add guidance for configuring gh-pages Adds instructions to configure GitHub Pages to correctly find and deploy the built files. * Update docs/publish/gh-pages.md Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> --- docs/publish/gh-pages.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/publish/gh-pages.md b/docs/publish/gh-pages.md index 13ec15f5..72f05f86 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`. -- GitLab