3 *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.
7 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.
9 ![Poole](https://f.cloud.github.com/assets/98681/1834359/71ae4048-73db-11e3-9a3c-df38eb170537.png)
11 See Poole in action with [the demo site](http://demo.getpoole.com).
13 There are currently two official themes built on Poole:
15 * [Hyde](http://hyde.getpoole.com)
16 * [Lanyon](http://lanyon.getpoole.com)
18 Individual theme feedback and bug reports should be submitted to the theme's individual repository.
25 - [Rems, `font-size`, and scaling](#rems-font-size-and-scaling)
26 - [Development](#development)
33 ### 1. Install dependencies
35 Poole is built on Jekyll and uses it's built-in SCSS compiler to generate our CSS. Before getting started, you'll need to install the Jekyll gem:
41 **Windows users:** Windows users have a bit more work to do, but luckily [@juthilo](https://github.com/juthilo) has your back with his [Run Jekyll on Windows](https://github.com/juthilo/run-jekyll-on-windows) guide.
43 **Need syntax highlighting?** Poole includes support for Pygments or Rouge, so install your gem of choice to make use of the built-in styling. Read more about this [in the Jekyll docs](http://jekyllrb.com/docs/templates/#code_snippet_highlighting).
47 To help anyone with any level of familiarity with Jekyll quickly get started, Poole includes everything you need for a basic Jekyll site. To that end, just download Poole and start up Jekyll.
49 ### 2b. Roll your own Jekyll site
51 Folks wishing to use Jekyll's templates and styles can do so with a little bit of manual labor. Download Poole and then copy what you need (likely `_layouts/`, `*.html` files, `atom.xml` for RSS, and `public/` for CSS, JS, etc.).
53 ### 3. Running locally
55 To see your Jekyll site with Poole applied, start a Jekyll server. In Terminal, from `/Poole` (or whatever your Jekyll site's root directory is named):
61 Open <http://localhost:4000> in your browser, and voilĂ .
65 If you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project.
67 1. Fork this repo and switch to the `gh-pages` branch.
68 1. 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.
69 2. 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.**
70 3. Done! Head to your GitHub Pages URL or custom domain.
72 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.
76 Poole includes some customizable options, typically applied via classes on the `<body>` element.
79 ### Rems, `font-size`, and scaling
81 Poole is built almost entirely with `rem`s (instead of pixels). `rem`s are like `em`s, but instead of building on the immediate parent's `font-size`, they build on the root element, `<html>`.
83 By default, we use the following:
90 @media (min-width: 38em) {
98 To easily scale your site's typography and components, simply customize the base `font-size`s here.
103 Poole has two branches, but only one is used for active development.
105 - `master` for development. **All pull requests should be to submitted against `master`.**
106 - `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.**
112 - <https://github.com/mdo>
113 - <https://twitter.com/mdo>
118 Open sourced under the [MIT license](LICENSE.md).