Browse Source

document the baseurl in the readme

Mark Otto 11 years ago
parent
commit
28ad727461
1 changed files with 7 additions and 1 deletions
  1. 7 1
      README.md

+ 7 - 1
README.md

@@ -58,7 +58,13 @@ To see your Jekyll site with Poole applied, start a Jekyll server. In Terminal,
 $ jekyll serve
 ```
 
-Open <http://localhost:4000> in your browser, and voilà. You're done.
+Open <http://localhost:4000> 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