From 28ad727461842782493d258bb0ee981fa1b520e4 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Tue, 20 May 2014 18:38:56 -0700 Subject: [PATCH] document the baseurl in the readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e11acd9..3abf4d1 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,13 @@ To see your Jekyll site with Poole applied, start a Jekyll server. In Terminal, $ jekyll serve ``` -Open in your browser, and voilà. You're done. +Open in your browser, and voilà. + +### 4. Serving it up + +If you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project. Simply create a `gh-pages` branch in your repository and push it to GitHub. Then head to `http://username.github.io/repo-name`. + +No matter your production or hosting setup, be sure to check your `baseurl` setting in the `_config.yml` file. For the above example, you'll want to change it from `/` to `/repo-name`. If you have a `CNAME` or host this at the root level of a domain, like `http://example.com`, there's no need to change anything. Not setting this correctly will mean broken styles on your site. ## Options -- 2.30.2