The Jekyll Butler. A no frills responsive Jekyll blog theme.
Overview
Poole is a static site generator designed and developed by @mdo. It provides a clear and concise foundational setup for any Jekyll site, including example templates, pages, posts, and styles. Poole takes its name from the loyal butler in the novel “The Strange Case of Dr. Jekyll and Mr. Hyde.”
Features
- Full vanilla Jekyll install with example templates, pages, posts, and styles
- Support for Pygments or Rouge for syntax highlighting
- Quick start option for beginners to quickly get started with Jekyll
- Option to roll your own Jekyll site by manually copying the necessary files
- Easy local server setup to view Jekyll site with Poole applied
- GitHub Pages integration for easy hosting on GitHub
- Custom domain name support with CNAME file modification
- Branches for active development and hosted site
Installation
- Install the Jekyll gem and related dependencies. Windows users can follow the “Run Jekyll on Windows” guide provided by @juthilo.
- Choose one of the following options:
- Quick start: Download Poole and start up Jekyll to have everything you need for a basic Jekyll site.
- Roll your own Jekyll site: Download Poole and manually copy the necessary files (e.g., _layouts/, *.html files, atom.xml, assets/) to use Jekyll’s templates and styles.
- Run the Jekyll server in Terminal from the root directory of your Jekyll site.
- Open http://localhost:4000 in your browser to see your Jekyll site with Poole applied.
- If you host your code on GitHub, you can use GitHub Pages to host your project by forking the Poole repo, switching to the gh-pages branch, and modifying the CNAME and _config.yml files accordingly.
- Verify the baseurl option file and CNAME settings to ensure proper styling on your site.
Summary
Poole is a powerful static site generator that provides a foundational setup for Jekyll sites. It offers a range of features including example templates, support for syntax highlighting, and easy deployment with GitHub Pages. With Poole, users can quickly get started with Jekyll or customize their own Jekyll site. Its integration with GitHub makes it a convenient choice for hosting projects.
