_ Git - blog/blob - README.md

   1 # Poole
   2
   3 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.
   4
   5 There are currently two themes built on Poole:
   6
   7 * [Hyde](http://hyde.getpoole.com)
   8 * [Lanyon](http://lanyon.getpoole.com)
   9
  10 ![Poole](https://f.cloud.github.com/assets/98681/1825252/f61f1fec-71af-11e3-8e90-fdd031b64308.png)
  11
  12
  13 ## Usage
  14
  15 ### 1. Install Jekyll
  16
  17 Poole is built for use with Jekyll, so naturally you'll need to install that. On Macs, it's rather straightforward:
  18
  19 ```bash
  20 $ gem install jekyll
  21 ```
  22
  23 **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.
  24
  25 You may also need to install Pygments, the Python syntax highlighter for code snippets that plays nicely with Jekyll. Read more about this [in the Jekyll docs](http://jekyllrb.com/docs/templates/#code_snippet_highlighting).
  26
  27 ### 2a. Quick start
  28
  29 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.
  30
  31 ### 2b. Roll your own Jekyll site
  32
  33 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.).
  34
  35 ### 3. Running locally
  36
  37 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):
  38
  39 ```bash
  40 $ jekyll serve
  41 ```
  42
  43 Open <http://localhost:4000> in your browser, and voilà. You're done.
  44
  45
  46 ## Options
  47
  48 Poole includes some customizable options, typically applied via classes on the `<body>` element.
  49
  50
  51 ### Rems, `font-size`, and scaling
  52
  53 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>`.
  54
  55 By default, we use the following:
  56
  57 ```css
  58 html {
  59   font-size: 16px;
  60   line-height: 1.5;
  61 }
  62 @media (min-width: 38rem) {
  63   html {
  64     font-size: 20px;
  65   }
  66 }
  67
  68 ```
  69
  70 To easily scale your site's typography and components, simply customize the base `font-size`s here.
  71
  72
  73 ## Author
  74
  75 **Mark Otto**
  76 - <https://github.com/mdo>
  77 - <https://twitter.com/mdo>
  78
  79
  80 ## License
  81
  82 Open sourced under the [MIT license](LICENSE.md).
  83
  84 <3