Add note about using Custom Domain with Github Pages (#4006)

* Update how-gatsby-works-with-github-pages.md * Update how-gatsby-works-with-github-pages.md * Update how-gatsby-works-with-github-pages.md
gatsbyjs · Feb 13, 2018 · a2139a5 · a2139a5
1 parent d5d9815
commit a2139a5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/docs/how-gatsby-works-with-github-pages.md b/docs/docs/how-gatsby-works-with-github-pages.md
@@ -44,3 +44,7 @@ In this case we dont need to specify `pathPrefix`, but our website needs to be p
 ```
 
 After running `yarn run deploy` you should see your website at `http://username.github.io`
+
+## Custom domains
+
+If you use a [custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/), don't add a `pathPrefix` as it will break navigation on your site. Path prefixing is only necessary when the site is *not* at the root of the domain like with repository sites.