Тайлбар байхгүй

Mark Otto de782617d4 Merge branch 'master' of https://github.com/poole/poole		11 жил өмнө
_includes	633aed112b add all the things	11 жил өмнө
_layouts	633aed112b add all the things	11 жил өмнө
_posts	2bbb0937fa styles update for container and some html elements; example content post updated	11 жил өмнө
public	2bbb0937fa styles update for container and some html elements; example content post updated	11 жил өмнө
.gitignore	633aed112b add all the things	11 жил өмнө
404.html	633aed112b add all the things	11 жил өмнө
CNAME	f23c6f8d2a new cname	11 жил өмнө
LICENSE.md	633aed112b add all the things	11 жил өмнө
README.md	156260e46a demo link in readme	11 жил өмнө
_config.yml	49380e2ce4 Change markdown engine from rdiscount to redcarpet	11 жил өмнө
about.md	504cbb101e text	11 жил өмнө
atom.xml	633aed112b add all the things	11 жил өмнө
index.html	633aed112b add all the things	11 жил өмнө

Poole

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.

See Poole in action with the demo site.

There are currently two official themes built on Poole:

Hyde
Lanyon

Individual theme feedback and bug reports should be submitted to the theme's individual repository.

Usage

1. Install Jekyll

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.

2a. Quick start

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.

2b. Roll your own Jekyll site

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.).

3. Running locally

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.

Options

Poole includes some customizable options, typically applied via classes on the <body> element.

Rems, `font-size`, and scaling

Poole is built almost entirely with rems (instead of pixels). rems are like ems, 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-sizes here.

Author

Mark Otto

License

Open sourced under the MIT license.

README.md