From f7bd7fd6360151976f70182c35495dcdd1ff8f2f Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Sat, 6 Jan 2018 21:31:51 -0500 Subject: [PATCH] Adjust formatting --- README.md | 70 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 48 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 43dd3a9..f27312a 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,10 @@ with a few enhancements thrown in for good measure: ## Installation -If you're running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem. If you're hosting with GitHub Pages you can install as a remote theme or directly copy all of the theme files (see -[structure](#structure) below) into your project. +If you're running Jekyll v3.5+ and self-hosting you can quickly install the +theme as a Ruby gem. If you're hosting with GitHub Pages you can install as a +remote theme or directly copy all of the theme files (see [structure](#structure) +below) into your project. ### Ruby Gem Method @@ -92,7 +94,8 @@ If you're running Jekyll v3.5+ and self-hosting you can quickly install the them ### GitHub Pages Method -GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme-with-github-pages) for any GitHub-hosted theme. +GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme-with-github-pages) +for any GitHub-hosted theme. 1. Replace `gem "jekyll"` with: @@ -102,13 +105,20 @@ GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme 2. Run `bundle update` and verify that all gems install properly. -3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entries. +3. Add `remote_theme: "mmistakes/jekyll-theme-basically-basic"` to your + `_config.yml` file. Remove any other `theme:` or `remote_theme:` entries. --- -**Note:** Your Jekyll site should be viewable immediately at . If it's not, you can force a rebuild by **Customizing Your Site** (see below for more details). +**Note:** Your Jekyll site should be viewable immediately at +. If it's not, you can force a rebuild by +**Customizing Your Site** (see below for more details). -If you're hosting several Jekyll based sites under the same GitHub username you will have to use Project Pages instead of User Pages. Essentially you rename the repo to something other than **USERNAME.github.io** and create a `gh-pages` branch off of `master`. For more details on how to set things up check [GitHub's documentation](https://help.github.com/articles/user-organization-and-project-pages/). +If you're hosting several Jekyll based sites under the same GitHub username you +will have to use Project Pages instead of User Pages. Essentially you rename the +repo to something other than **USERNAME.github.io** and create a `gh-pages` +branch off of `master`. For more details on how to set things up check +[GitHub's documentation](https://help.github.com/articles/user-organization-and-project-pages/). #### Remove the Unnecessary @@ -131,9 +141,11 @@ safely remove the following files and folders: ## Upgrading -If you're using the Ruby Gem or remote theme versions of Basically Basic, upgrading is fairly painless. +If you're using the Ruby Gem or remote theme versions of Basically Basic, +upgrading is fairly painless. -To check which version you are currently using, view the source of your built site and you should something similar to: +To check which version you are currently using, view the source of your built +site and you should something similar to: ```