Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poole/poole
The Jekyll Butler. A no frills responsive Jekyll blog theme.
https://github.com/poole/poole
jekyll jekyll-theme
Last synced: 1 day ago
JSON representation
The Jekyll Butler. A no frills responsive Jekyll blog theme.
- Host: GitHub
- URL: https://github.com/poole/poole
- Owner: poole
- License: other
- Created: 2013-12-29T23:39:18.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T02:50:01.000Z (8 months ago)
- Last Synced: 2024-10-29T14:53:14.498Z (3 months ago)
- Topics: jekyll, jekyll-theme
- Language: CSS
- Homepage: https://getpoole.com
- Size: 148 KB
- Stars: 2,824
- Watchers: 72
- Forks: 1,952
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Poole
*The Strange Case of Dr. Jekyll 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.
-----
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.
See Poole in action with [the demo site](https://demo.getpoole.com).
There are currently two official themes built on Poole:
* [Hyde](https://hyde.getpoole.com)
* [Lanyon](https://lanyon.getpoole.com)
Individual theme feedback and bug reports should be submitted to the theme's individual repository.
## Contents
- [Usage](#usage)
- [Development](#development)
- [Author](#author)
- [License](#license)
## Usage
### 1. Install dependencies
Poole is built on Jekyll and uses its built-in SCSS compiler to generate our CSS. Before getting started, you'll need to install the Jekyll gem and related dependencies:
```bash
$ gem install jekyll jekyll-gist jekyll-sitemap jekyll-seo-tag
```
**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.
**Need syntax highlighting?** Poole includes support for Pygments or Rouge, so install your gem of choice to make use of the built-in styling. Read more about this in the [Jekyll docs](https://jekyllrb.com/docs/liquid/tags/#code-snippet-highlighting).
### 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 `assets/` 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):
```bash
$ jekyll serve
```
Open in your browser, and voilà.
### 4. Serving it up
If you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project.
1. Fork this repo and switch to the `gh-pages` branch.
1. If you're [using a custom domain name](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages), modify the `CNAME` file to point to your new domain.
2. If you're not using a custom domain name, **modify the `baseurl` in `_config.yml`** to point to your GitHub Pages URL. Example: for a repo at `github.com/username/poole`, use `http://username.github.io/poole/`. **Be sure to include the trailing slash.**
3. Done! Head to your GitHub Pages URL or custom domain.
No matter your production or hosting setup, be sure to verify the `baseurl` option file and `CNAME` settings. Not applying this correctly can mean broken styles on your site.
## Development
Poole has two branches, but only one is used for active development.
- `master` for development. **All pull requests should be to submitted against `master`.**
- `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.**
CSS is handled via Jeykll's built-in Sass compiler. Source Sass files are located in `_sass/`, included into `styles.scss`, and compile to `styles.css`.
## Author
**Mark Otto**
-
-
## License
Open sourced under the [MIT license](LICENSE.md).
<3