From: Mark Otto Date: Mon, 22 Jun 2015 00:11:51 +0000 (-0700) Subject: Merge branch 'master' into gh-pages X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=84e75644dda47abc6a24f1bf332b863f518ab950;hp=e5e4f6693dd954f6b79c13cd91cfcabdc80f23d8;p=blog Merge branch 'master' into gh-pages Conflicts: _includes/head.html --- diff --git a/.gitignore b/.gitignore index 10c58cf..33c0adb 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ _gh_pages _site .ruby-version +.sass-cache # Numerous always-ignore extensions *.diff diff --git a/404.html b/404.html index 9703ba8..4bf3f7d 100644 --- a/404.html +++ b/404.html @@ -6,5 +6,5 @@ permalink: 404.html

404: Page not found

Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. Head back home to try finding it again.

diff --git a/README.md b/README.md index 1e5626a..a34a7a6 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ Individual theme feedback and bug reports should be submitted to the theme's ind ## Usage -### 1. Install Jekyll +### 1. Install dependencies -Poole is built for use with Jekyll, so naturally you'll need to install that. On Macs, it's rather straightforward: +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: ```bash $ gem install jekyll @@ -40,7 +40,7 @@ $ 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). +**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](http://jekyllrb.com/docs/templates/#code_snippet_highlighting). ### 2a. Quick start @@ -52,7 +52,7 @@ Folks wishing to use Jekyll's templates and styles can do so with a little bit o ### 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): +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 @@ -65,13 +65,12 @@ Open in your browser, and voilÃ . 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. -2a. 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. -2b. 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.** + 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. - ## Options Poole includes some customizable options, typically applied via classes on the `` element. @@ -106,6 +105,7 @@ 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 diff --git a/_config.yml b/_config.yml index 5febafb..fddf614 100644 --- a/_config.yml +++ b/_config.yml @@ -1,23 +1,30 @@ -# Dependencies -markdown: redcarpet -highlighter: pygments - # Permalinks -permalink: pretty +# +# Use of `relative_permalinks` ensures post links from the index work properly. +permalink: pretty relative_permalinks: true # Setup -title: Poole -tagline: The Jekyll Butler -url: http://getpoole.com -paginate: 1 -baseurl: / +title: Poole +tagline: The Jekyll Butler +url: http://getpoole.com +paginate: 1 +baseurl: "" + +# Assets +# +# We specify the directory for Jekyll so we can use @imports. +sass: + sass_dir: _sass + style: :compressed + +# About/contact author: - name: Mark Otto - url: https://twitter.com/mdo - email: markdotto@gmail.com + name: Mark Otto + url: https://twitter.com/mdo + email: markdotto@gmail.com # Custom vars -version: 1.0.0 +version: 1.0.0 github: - repo: https://github.com/poole/poole + repo: https://github.com/poole/poole diff --git a/_includes/head.html b/_includes/head.html index fc3ffb6..71f25b2 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -3,7 +3,7 @@ - + {% if page.title == "Home" %} @@ -14,15 +14,14 @@ - - + - - + + - +