X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=1e5626a00b8e70b0a55cdaec5fd70c12ab02e403;hb=2dbd03d58679d1d009cef1a335c31c82ed4197c5;hp=1fbc6485bd50106571cd43396b675f36ef079157;hpb=156260e46ac1fa197624fcce3982b0a63acc653b;p=blog diff --git a/README.md b/README.md index 1fbc648..1e5626a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # Poole -In the novel, *The Strange Case of Dr. Jeykll and Mr. Hyde*, Mr. Poole is Dr. Jekyll's virtuous and loyal butler. Similarly, Poole is the Butler for Jekyll themes by [@mdo](https://twitter.com/mdo), providing a clear and concise foundational setup for any Jekyll site. +*The Strange Case of Dr. Jekyll and Mr. Hyde* tells the story of a lawyer investigating the connection of two persons, Dr. Henry Jekyll and Mr. Edward Hyde. Chief among the novel's supporting cast is a man by the name of Mr. Poole, Dr. Jekyll's loyal butler. -![Poole](https://f.cloud.github.com/assets/98681/1825252/f61f1fec-71af-11e3-8e90-fdd031b64308.png) +----- + +Poole is the butler for [Jekyll](http://jekyllrb.com), the static site generator. It's designed and developed by [@mdo](https://twitter.com/mdo) to provide a clear and concise foundational setup for any Jekyll site. It does so by furnishing a full vanilla Jekyll install with example templates, pages, posts, and styles. + +![Poole](https://f.cloud.github.com/assets/98681/1834359/71ae4048-73db-11e3-9a3c-df38eb170537.png) See Poole in action with [the demo site](http://demo.getpoole.com). @@ -14,6 +18,16 @@ There are currently two official themes built on Poole: Individual theme feedback and bug reports should be submitted to the theme's individual repository. +## Contents + +- [Usage](#usage) +- [Options](#options) + - [Rems, `font-size`, and scaling](#rems-font-size-and-scaling) +- [Development](#development) +- [Author](#author) +- [License](#license) + + ## Usage ### 1. Install Jekyll @@ -44,7 +58,18 @@ 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. + +1. Fork this repo and switch to the `gh-pages` branch. +2a. If you're [using a custom domain name](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages), modify the `CNAME` file to point to your new domain. +2b. If you're not using a custom domain name, **modify the `baseurl` in `_config.yml`** to point to your GitHub Pages URL. Example: for a repo at `github.com/username/poole`, use `http://username.github.io/poole/`. **Be sure to include the trailing slash.** +3. Done! Head to your GitHub Pages URL or custom domain. + +No matter your production or hosting setup, be sure to verify the `baseurl` option file and `CNAME` settings. Not applying this correctly can mean broken styles on your site. ## Options @@ -63,7 +88,7 @@ html { font-size: 16px; line-height: 1.5; } -@media (min-width: 38rem) { +@media (min-width: 38em) { html { font-size: 20px; } @@ -74,6 +99,14 @@ html { To easily scale your site's typography and components, simply customize the base `font-size`s here. +## Development + +Poole has two branches, but only one is used for active development. + +- `master` for development. **All pull requests should be to submitted against `master`.** +- `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.** + + ## Author **Mark Otto**