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