From: Mark Otto Date: Sun, 19 Apr 2015 05:08:46 +0000 (-0700) Subject: Merge branch 'master' into sass X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=68a55e96a41b80de4b350c67f4e6feed7a3079fe;hp=-c;p=blog Merge branch 'master' into sass --- 68a55e96a41b80de4b350c67f4e6feed7a3079fe diff --combined README.md index d470c87,6038a38..58e8edd --- a/README.md +++ b/README.md @@@ -30,18 -30,17 +30,18 @@@ Individual theme feedback and bug repor ## 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 SCSS instead of vanilla CSS. Before getting started, you'll need to install their gems: ```bash $ gem install jekyll +$ gem install scss ``` **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 @@@ -66,13 -65,12 +66,12 @@@ Open in your br 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. diff --combined _config.yml index 30929c2,276c57e..a2229f2 --- a/_config.yml +++ b/_config.yml @@@ -1,34 -1,19 +1,34 @@@ +# Dependencies - markdown: redcarpet ++markdown: kramdown +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: _scss + 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