]> git.bitcoin.ninja Git - blog/commitdiff
document the baseurl in the readme
authorMark Otto <otto@github.com>
Wed, 21 May 2014 01:38:56 +0000 (18:38 -0700)
committerMark Otto <otto@github.com>
Wed, 21 May 2014 01:38:56 +0000 (18:38 -0700)
README.md

index e11acd9da15222ed61c62bbec9b2b9231698d0ed..3abf4d10a71dbf6e1fd0e1881b4de17a8ad1d3dd 100644 (file)
--- 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 <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