{"id":13397425,"url":"https://github.com/poole/poole","last_synced_at":"2025-05-13T22:12:12.566Z","repository":{"id":12841243,"uuid":"15516827","full_name":"poole/poole","owner":"poole","description":"The Jekyll Butler. A no frills responsive Jekyll blog theme.","archived":false,"fork":false,"pushed_at":"2024-05-23T02:50:01.000Z","size":152,"stargazers_count":2842,"open_issues_count":16,"forks_count":1977,"subscribers_count":71,"default_branch":"master","last_synced_at":"2025-04-30T14:16:00.564Z","etag":null,"topics":["jekyll","jekyll-theme"],"latest_commit_sha":null,"homepage":"https://getpoole.com","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/poole.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-12-29T23:39:18.000Z","updated_at":"2025-04-26T04:21:03.000Z","dependencies_parsed_at":"2022-07-14T02:10:42.769Z","dependency_job_id":"68306e0a-7bb7-4d7b-9c00-855c59ad3b6b","html_url":"https://github.com/poole/poole","commit_stats":{"total_commits":143,"total_committers":33,"mean_commits":4.333333333333333,"dds":0.5384615384615384,"last_synced_commit":"de4583f5f5ee148d344a494a7f3750eae8ec9e3e"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poole%2Fpoole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poole%2Fpoole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poole%2Fpoole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/poole%2Fpoole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/poole","download_url":"https://codeload.github.com/poole/poole/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254036842,"owners_count":22003654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jekyll","jekyll-theme"],"created_at":"2024-07-30T18:01:23.008Z","updated_at":"2025-05-13T22:12:07.556Z","avatar_url":"https://github.com/poole.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"# Poole\n\n*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.\n\n-----\n\nPoole 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.\n\n![Poole](https://f.cloud.github.com/assets/98681/1834359/71ae4048-73db-11e3-9a3c-df38eb170537.png)\n\nSee Poole in action with [the demo site](https://demo.getpoole.com).\n\nThere are currently two official themes built on Poole:\n\n* [Hyde](https://hyde.getpoole.com)\n* [Lanyon](https://lanyon.getpoole.com)\n\nIndividual theme feedback and bug reports should be submitted to the theme's individual repository.\n\n\n## Contents\n\n- [Usage](#usage)\n- [Development](#development)\n- [Author](#author)\n- [License](#license)\n\n\n## Usage\n\n### 1. Install dependencies\n\nPoole 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:\n\n```bash\n$ gem install jekyll jekyll-gist jekyll-sitemap jekyll-seo-tag\n```\n\n**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.\n\n**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).\n\n### 2a. Quick start\n\nTo 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.\n\n### 2b. Roll your own Jekyll site\n\nFolks 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.).\n\n### 3. Running locally\n\nTo 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):\n\n```bash\n$ jekyll serve\n```\n\nOpen \u003chttp://localhost:4000\u003e in your browser, and voilà.\n\n### 4. Serving it up\n\nIf you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project.\n\n1. Fork this repo and switch to the `gh-pages` branch.\n  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.\n  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.**\n3. Done! Head to your GitHub Pages URL or custom domain.\n\nNo 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.\n\n## Development\n\nPoole has two branches, but only one is used for active development.\n\n- `master` for development.  **All pull requests should be to submitted against `master`.**\n- `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.**\n\nCSS 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`.\n\n## Author\n\n**Mark Otto**\n- \u003chttps://github.com/mdo\u003e\n- \u003chttps://twitter.com/mdo\u003e\n\n\n## License\n\nOpen sourced under the [MIT license](LICENSE.md).\n\n\u003c3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpoole%2Fpoole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpoole%2Fpoole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpoole%2Fpoole/lists"}