_ Git - blog/blob - README.md

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