From d8a7d770b443c9595ebb3d81c2bdc0f5fc9abae3 Mon Sep 17 00:00:00 2001 From: Bud Parr Date: Thu, 31 Jul 2014 17:54:56 -0400 Subject: [PATCH] add warning flag to note --- site/_docs/github-pages.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/site/_docs/github-pages.md b/site/_docs/github-pages.md index f126db0d..62977776 100644 --- a/site/_docs/github-pages.md +++ b/site/_docs/github-pages.md @@ -30,7 +30,7 @@ repository](https://github.com/mojombo/mojombo.github.io) has the name Content from the `master` branch of your repository will be used to build and publish the GitHub Pages site, so make sure your Jekyll site is stored there. -
+
Custom domains do not affect repository names

GitHub Pages are initially configured to live under the @@ -54,6 +54,14 @@ actual software project for Jekyll, however the Jekyll website (that you’re looking at right now) is contained in the [gh-pages branch]({{ site.repository }}/tree/gh-pages) of the same repository. +

+
Source Files Must be in the Root Directory
+

Github Pages [overrides](https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting) the ["Site Source"](http://jekyllrb.com/docs/configuration/#global-configuration) configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly. + +

+
+ + ### Project Page URL Structure Sometimes it's nice to preview your Jekyll site before you push your `gh-pages`