Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgrebenets/i4napps.github.io
Organization Pages
https://github.com/mgrebenets/i4napps.github.io
Last synced: 6 days ago
JSON representation
Organization Pages
- Host: GitHub
- URL: https://github.com/mgrebenets/i4napps.github.io
- Owner: mgrebenets
- License: other
- Created: 2014-05-22T11:35:15.000Z (over 10 years ago)
- Default Branch: gh-pages
- Last Pushed: 2014-05-22T11:55:52.000Z (over 10 years ago)
- Last Synced: 2024-10-31T22:12:57.421Z (about 2 months ago)
- Language: CSS
- Size: 598 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Poole
*The Strange Case of Dr. Jeykll 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](http://demo.getpoole.com).
There are currently two official themes built on Poole:
* [Hyde](http://hyde.getpoole.com)
* [Lanyon](http://lanyon.getpoole.com)
Individual theme feedback and bug reports should be submitted to the theme's individual repository.
## Contents
- [Usage](#usage)
- [Options](#options)
- [Rems, `font-size`, and scaling](#rems-font-size-and-scaling)
- [Development](#development)
- [Author](#author)
- [License](#license)
## 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:
```bash
$ gem install jekyll
```
**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.
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](http://jekyllrb.com/docs/templates/#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 `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):
```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. Simply create a `gh-pages` branch in your repository and push it to GitHub. Then head to `http://username.github.io/repo-name`.
No matter your production or hosting setup, be sure to check your `baseurl` setting in the `_config.yml` file. For the above example, you'll want to change it from `/` to `/repo-name`. If you have a `CNAME` or host this at the root level of a domain, like `http://example.com`, there's no need to change anything. Not setting this correctly will mean broken styles on your site.
## Options
Poole includes some customizable options, typically applied via classes on the `` element.
### Rems, `font-size`, and scaling
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, ``.
By default, we use the following:
```css
html {
font-size: 16px;
line-height: 1.5;
}
@media (min-width: 38em) {
html {
font-size: 20px;
}
}
```
To easily scale your site's typography and components, simply customize the base `font-size`s here.
## 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.**
## Author
**Mark Otto**
-
-
## License
Open sourced under the [MIT license](LICENSE.md).
<3