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, providing a clear and concise foundational setup for any Jekyll site.
There are currently two official themes built on Poole:
Individual theme feedback and bug reports should be submitted to the theme's individual repository.
Poole is built for use with Jekyll, so naturally you'll need to install that. On Macs, it's rather straightforward:
$ gem install jekyll
Windows users: Windows users have a bit more work to do, but luckily @juthilo has your back with his Run Jekyll on Windows guide.
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.
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.
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.).
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):
$ jekyll serve
Open http://localhost:4000 in your browser, and voilà. You're done.
Poole includes some customizable options, typically applied via classes on the <body>
element.
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>
.
By default, we use the following:
html {
font-size: 16px;
line-height: 1.5;
}
@media (min-width: 38rem) {
html {
font-size: 20px;
}
}
To easily scale your site's typography and components, simply customize the base font-size
s here.
Mark Otto
Open sourced under the MIT license.
<3