RubyGems - jekyll-theme-so-simple - Versions diffs - 3.0.0 - Mend

jekyll-theme-so-simple 3.0.0

Files changed (130) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +235 -0
data/LICENSE +49 -0
data/README.md +1145 -0
data/_data/authors.yml +16 -0
data/_data/navigation.yml +14 -0
data/_data/text.yml +36 -0
data/_includes/disqus-comments.html +19 -0
data/_includes/documents-collection.html +3 -0
data/_includes/entry-date.html +6 -0
data/_includes/entry.html +39 -0
data/_includes/footer-custom.html +3 -0
data/_includes/footer.html +24 -0
data/_includes/google-analytics.html +9 -0
data/_includes/head-custom.html +5 -0
data/_includes/head-feed.html +1 -0
data/_includes/head-seo.html +1 -0
data/_includes/head.html +50 -0
data/_includes/lunr-search-scripts.html +106 -0
data/_includes/masthead.html +13 -0
data/_includes/navigation.html +17 -0
data/_includes/page-author.html +37 -0
data/_includes/page-categories.html +14 -0
data/_includes/page-date.html +4 -0
data/_includes/page-image.html +14 -0
data/_includes/page-pagination.html +19 -0
data/_includes/page-tags.html +14 -0
data/_includes/posts-all.html +3 -0
data/_includes/posts-category.html +3 -0
data/_includes/posts-limit.html +3 -0
data/_includes/posts-paginated.html +74 -0
data/_includes/posts-tag.html +3 -0
data/_includes/read-time.html +16 -0
data/_includes/responsive-embed +16 -0
data/_includes/scripts.html +43 -0
data/_includes/skip-links.html +8 -0
data/_includes/social-share.html +6 -0
data/_includes/toc +9 -0
data/_layouts/categories.html +48 -0
data/_layouts/category.html +9 -0
data/_layouts/collection.html +9 -0
data/_layouts/default.html +22 -0
data/_layouts/home.html +17 -0
data/_layouts/page.html +30 -0
data/_layouts/post.html +41 -0
data/_layouts/posts.html +29 -0
data/_layouts/search.html +11 -0
data/_layouts/tag.html +9 -0
data/_layouts/tags.html +48 -0
data/_sass/so-simple.scss +31 -0
data/_sass/so-simple/_author.scss +45 -0
data/_sass/so-simple/_base.scss +112 -0
data/_sass/so-simple/_buttons.scss +92 -0
data/_sass/so-simple/_entries.scss +182 -0
data/_sass/so-simple/_functions.scss +4 -0
data/_sass/so-simple/_global.scss +393 -0
data/_sass/so-simple/_icons.scss +43 -0
data/_sass/so-simple/_mixins.scss +5 -0
data/_sass/so-simple/_notices.scss +93 -0
data/_sass/so-simple/_page.scss +282 -0
data/_sass/so-simple/_reset.scss +523 -0
data/_sass/so-simple/_syntax-highlighting.scss +334 -0
data/_sass/so-simple/_tables.scss +34 -0
data/_sass/so-simple/_utilities.scss +7 -0
data/_sass/so-simple/_variables.scss +132 -0
data/_sass/so-simple/functions/_color.scss +21 -0
data/_sass/so-simple/functions/_em.scss +7 -0
data/_sass/so-simple/functions/_fluid-type.scss +33 -0
data/_sass/so-simple/functions/_yiq.scss +38 -0
data/_sass/so-simple/mixins/_clearfix.scss +32 -0
data/_sass/so-simple/mixins/_float.scss +15 -0
data/_sass/so-simple/mixins/_image.scss +38 -0
data/_sass/so-simple/mixins/_lists.scss +9 -0
data/_sass/so-simple/mixins/_text-truncate.scss +10 -0
data/_sass/so-simple/utilities/_accessibility.scss +43 -0
data/_sass/so-simple/utilities/_align.scss +60 -0
data/_sass/so-simple/utilities/_animations.scss +99 -0
data/_sass/so-simple/utilities/_clearfix.scss +7 -0
data/_sass/so-simple/utilities/_float.scss +7 -0
data/_sass/so-simple/utilities/_responsive-embed.scss +66 -0
data/_sass/so-simple/utilities/_text.scss +48 -0
data/_sass/so-simple/vendor/breakpoint/_breakpoint.scss +114 -0
data/_sass/so-simple/vendor/breakpoint/_context.scss +95 -0
data/_sass/so-simple/vendor/breakpoint/_helpers.scss +151 -0
data/_sass/so-simple/vendor/breakpoint/_legacy-settings.scss +50 -0
data/_sass/so-simple/vendor/breakpoint/_no-query.scss +15 -0
data/_sass/so-simple/vendor/breakpoint/_parsers.scss +215 -0
data/_sass/so-simple/vendor/breakpoint/_respond-to.scss +82 -0
data/_sass/so-simple/vendor/breakpoint/_settings.scss +71 -0
data/_sass/so-simple/vendor/breakpoint/parsers/_double.scss +33 -0
data/_sass/so-simple/vendor/breakpoint/parsers/_query.scss +82 -0
data/_sass/so-simple/vendor/breakpoint/parsers/_resolution.scss +31 -0
data/_sass/so-simple/vendor/breakpoint/parsers/_single.scss +26 -0
data/_sass/so-simple/vendor/breakpoint/parsers/_triple.scss +36 -0
data/_sass/so-simple/vendor/breakpoint/parsers/double/_default-pair.scss +21 -0
data/_sass/so-simple/vendor/breakpoint/parsers/double/_default.scss +22 -0
data/_sass/so-simple/vendor/breakpoint/parsers/double/_double-string.scss +22 -0
data/_sass/so-simple/vendor/breakpoint/parsers/resolution/_resolution.scss +60 -0
data/_sass/so-simple/vendor/breakpoint/parsers/single/_default.scss +13 -0
data/_sass/so-simple/vendor/breakpoint/parsers/triple/_default.scss +18 -0
data/_sass/so-simple/vendor/lity/_lity.scss +221 -0
data/assets/css/main.scss +8 -0
data/assets/js/lunr/lunr.da.min.js +18 -0
data/assets/js/lunr/lunr.de.min.js +18 -0
data/assets/js/lunr/lunr.du.min.js +18 -0
data/assets/js/lunr/lunr.es.min.js +18 -0
data/assets/js/lunr/lunr.fi.min.js +18 -0
data/assets/js/lunr/lunr.fr.min.js +18 -0
data/assets/js/lunr/lunr.hu.min.js +18 -0
data/assets/js/lunr/lunr.it.min.js +18 -0
data/assets/js/lunr/lunr.ja.min.js +1 -0
data/assets/js/lunr/lunr.jp.min.js +1 -0
data/assets/js/lunr/lunr.min.js +6 -0
data/assets/js/lunr/lunr.multi.min.js +1 -0
data/assets/js/lunr/lunr.no.min.js +18 -0
data/assets/js/lunr/lunr.pt.min.js +18 -0
data/assets/js/lunr/lunr.ro.min.js +18 -0
data/assets/js/lunr/lunr.ru.min.js +18 -0
data/assets/js/lunr/lunr.stemmer.support.min.js +1 -0
data/assets/js/lunr/lunr.sv.min.js +18 -0
data/assets/js/lunr/lunr.tr.min.js +18 -0
data/assets/js/main.js +15 -0
data/assets/js/main.min.js +6 -0
data/assets/js/plugins/jquery.smooth-scroll.js +358 -0
data/assets/js/plugins/jquery.smooth-scroll.min.js +9 -0
data/assets/js/plugins/lity.js +655 -0
data/assets/js/plugins/lity.min.js +5 -0
data/assets/js/plugins/table-of-contents.js +59 -0
data/assets/js/search-data.json +27 -0
metadata +312 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11a80253cd79fb5e5e06898443573b197ba057a7
+  data.tar.gz: 7c49f8216bee9a6a4eb4f6035b38729d56529776
+SHA512:
+  metadata.gz: b96b024d56d4ecbe0b7f1df547f85398679e32f26772943ae616134c3239d21f3424001ee461b2682b498b42d4a2ca44146683c823e6b0881d31f8564c0a3e9c
+  data.tar.gz: b678b268e57da5201f6c08fe6c06eb22eeb495eb3828fcf04d2b38cf981350fea69e51238d31231881b9248da030abae2a9d68e58a5ef8f981b5501ad7cdbe05

data/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,235 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+## Unreleased
+### Changed
+- Freshen up look and feel, rebuilding with modern CSS using grid and flexbox.
+- Improve parity with Jekyll's default theme (Minima).
+- Properly support `url` and `baseurl` by leveraging Jekyll's `absolute_url` and `relative_url` filters.
+- Rename image front matter to those used by jekyll-seo-tag, jekyll-feed, and jekyll-sitemap (e.g., rename `image.feature` to `image.path`).
+- Require full paths to image assets instead of forcing them into `/images/`.
+- Update MathJax to `2.7.2`.
+- Update Font Awesome to `5.0.6`.
+- Update jQuery to `3.3.1`.
+- Remove FitVid.JS script.
+- Replace Magnific Popup with Lity.
+- Improve list view.
+- Replace JSON search with [Lunr](https://lunrjs.com/).
+- Improve syntax highlighting styling.
+- Improve README.md with full installation guide.
+- Replace Grunt tasks with `npm run` scripts.
+- Update GitHub issue labels.
+- Migrate `gh-pages` branch into `/docs` folder on `master`.
+### Added
+- Convert into a [Ruby gem-based theme](https://jekyllrb.com/docs/themes/#understanding-gem-based-themes).
+- Add support for installing on GitHub Pages as a [remote theme](https://github.com/benbalter/jekyll-remote-theme).
+- Add custom author links to post sidebar via `_config.yml`.
+- Add custom footer links via `_config.yml`.
+- Allow footer copyright to be changed via `_config.yml`.
+- Assign Google Fonts to easily customize site's typography via `_config.yml`.
+- Add hooks for injecting custom markup or content to `<head>` and `<footer>`.
+- Add estimated reading time to pages.
+- Add [data file](_data/text.yml) with all of the theme's text strings for localization.
+- Add grid view.
+- Add full document content, URL, and tags to search index for improved results.
+- Add support for line numbers in syntax highlighted code blocks.
+- Add toggle for showing or hiding excerpts with `show_excerpts`.
+- Add `default` layout.
+- Add `home` layout with [jekyll-paginate](https://jekyllrb.com/docs/pagination/) support.
+- Add `posts` layout for showing all posts.
+- Add `categories` layout for showing all posts grouped by category.
+- Add `category` layout for showing posts of a specific category.
+- Add `tags` layout for showing all posts grouped by tag.
+- Add `tag` layout for showing posts of a specific tag.
+- Add `collection` layout for showing documents of a specific collection.
+- Add `search` layout.
+- Add [Microformats](http://microformats.org/wiki/microformats2) markup to posts.
+- Add responsive embed helper.
+- Add table of contents helper.
+- Add CHANGELOG.md file.
+- Add migration guide for v2 to v3.
+- Add stale bot for dealing with inactive issues and pull-requests.
+- Add GitHub issue template.
+### Fixed
+- Fixed MathJax CDN path. [#241](https://github.com/mmistakes/so-simple-theme/pull/241)
+---
+## [2.3.4] - 09-14-2016
+### Changed
+- Change `spin` to `adjust-hue`. [#201](https://github.com/mmistakes/so-simple-theme/issues/201)
+- Improve readability of .scss files.
+## [2.3.3] - 09-12-2016
+### Changed
+- Removed pro tip on applying for Twitter Cards.
+## [2.3.2] - 09-12-2016
+### Fixed
+- Fix search.js interference with other forms. [#194](https://github.com/mmistakes/so-simple-theme/issues/194)
+- Fix parenthesis Liquid error in `_layouts/post.html`. [#141](https://github.com/mmistakes/so-simple-theme/issues/141)
+## [2.3.1] - 06-01-2016
+### Changed
+- Remove Octopress configuration from `_config.yml`.
+## [2.3.0] - 06-01-2016
+### Changed
+- Update gems.
+- Remove Octopress dependency.
+- Replace `{% highlight %}` tags with GitHub Flavored Markdown backticks.
+- Replace custom `feed.xml` with [jekyll-feed](https://github.com/jekyll/jekyll-feed) plugin.
+## [2.2.3] - 05-05-2016
+## [2.2.2] - 02-17-2016
+## [2.2.1] - 02-07-2016
+## [2.2.0] - 02-01-2016
+### Changed
+- Minor updates to `_syntax.scss` styling and theme documentation.
+### Added
+- Add compatibility with Jekyll 3.0.
+## [2.1.1] - 01-22-2015
+### Changed
+- Improve comments in Sass partials and remove unused styles from Less versions.
+- Enable Disqus comments globally instead of by post. [#94](https://github.com/mmistakes/so-simple-theme/issues/94)
+- Improve Jekyll search feature by removing poorly performing input box overlay on mobile and touch devices [#88](https://github.com/mmistakes/so-simple-theme/issues/88.
+- Move search form to dedicated page `/search/` and link to top navigation.
+### Added
+- Add post excerpts to index pages (`/blog`, `/articles`, and the home page) if set in a YAML Front Matter.
+### Fixed
+- Fix Disqus related bugs that were displaying `<noscript>` text on pages that had comments disabled.
+- Fix typos in theme documentation.
+## [2.1.0] - 01-22-2015
+## [2.0.0] - 08-08-2014
+## [1.4.0] - 02-12-2014
+### Added
+- Add rake tasks to create new posts or pages: `rake new_post` or `rake new_page`.
+## [1.3.2] - 01-02-2014
+### Added
+- Add social share links to the sidebar. To enable, add `share: true` to a post's YAML Front Matter.
+## [1.3.1] - 09-12-2013
+### Changed
+- Change order of navigation and browser upgrade includes. [#32](https://github.com/mmistakes/so-simple-theme/issues/32)
+### Added
+- Add Grunt build script for easier theme development. Preprocesses Less into CSS, concatenates and minifies JavaScript, and optimizes all images.
+- Add search by post title overlay using Christian Fei’s [Simple Jekyll jQuery plugin](https://github.com/christian-fei/Simple-Jekyll-Search).
+### Fixed
+- Fix menu close action when clicking outside of it. [#29](https://github.com/mmistakes/so-simple-theme/issues/29)
+- Fix jumpy navigation that was being absolutely positioned on click.
+## [1.3.0] - 09-11-2013
+## [1.2.11] - 08-16-2013
+### Added
+- Add support for summary large image Twitter Cards.
+### Fixed
+- Fix code syntax highlighting and added back Coderay styles for fenced code blocks.
+## [1.2.10] - 08-12-2013
+### Changed
+- Update theme preview image.
+- Update documentation.
+### Added
+- Add link post type support by adding `link: http://url-you-want-to-link` to a post's YAML Front Matter.
+### Fixed
+- Fix external links not being handled correctly in top navigation.
+- Fix code syntax highlighting CSS.
+## [1.2.9] - 08-05-2013
+### Changed
+- Refactor figure image classes to increase bottom padding when multiple rows of images are added to a figure element.
+### Added
+- Add hover effects to linked images in a `figure` element.
+- Add non-intrusive image credit (for feature images).
+### Fixed
+- Fix Pygment CSS conflict with MathJax. [#20](https://github.com/mmistakes/so-simple-theme/issues/20)
+- Fix RSS feed link in top navigation. [#21](https://github.com/mmistakes/so-simple-theme/issues/21)
+## [1.2.8] - 07-30-2013
+### Changed
+- Adjust navigation and site logo animations in header.
+- Adjust masthead feature images.
+## [1.2.7] - 07-29-2013
+### Fixed
+- Fix typo in `variables.less`.
+## [1.2.6] - 07-26-2013
+### Changed
+- Modify hover states of links in the top navigation bar.
+- Lighten body text to a dark gray to improve readability and lessen eye strain.
+## [1.2.5] - 07-19-2013
+### Changed
+- Increase space around top-navigation text.
+- Make Disqus comments optional and only load when `disqus_shortname` is defined and a post is set to `comments: true`.
+### Fixed
+- Fix post index `ul` element.
+## [1.2.4] - 07-18-2013
+## [1.2.3] - 07-17-2013
+## [1.2.1] - 07-12-2013
+### Changed
+- Optimize `head` by loading CSS before AdobeEdge webfont JavaScript.
+## [1.2.0] - 07-10-2013
+### Changed
+- Use [Google's enhance 404 widget](https://support.google.com/webmasters/answer/93641) to embed a search box in `404.md`.
+### Added
+- Add a starter 404 page.
+## [1.1.0] - 07-03-2013
+### Added
+- Add support for configurable external links in `_config.yml`.
+## [1.0.0] - 07-03-2013

data/LICENSE ADDED Viewed

@@ -0,0 +1,49 @@
+The MIT License (MIT)
+Copyright (c) 2013-2018 Michael Rose and contributors
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+So Simple incorporates [Font Awesome](http://fontawesome.io/),
+Copyright (c) 2017 Dave Gandy.
+Font Awesome is distributed under the terms of the [SIL OFL 1.1](http://scripts.sil.org/OFL)
+and [MIT License](http://opensource.org/licenses/MIT).
+So Simple incorporates photographs from [Unsplash](https://unsplash.com).
+So Simple incorporates photographs from [WeGraphics](http://wegraphics.net/downloads/free-ultimate-blurred-background-pack/)
+So Simple incorporates [Breakpoint](http://breakpoint-sass.com/).
+Breakpoint is distributed under the terms of the [MIT/GPL Licenses](http://opensource.org/licenses/MIT).
+So Simple incorporates [jQuery Smooth Scroll](https://github.com/kswedberg/jquery-smooth-scroll),
+Copyright (c) 2017 Karl Swedberg.
+jQuery Smooth Scroll is distributed under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+So Simple incorporates [Lunr](http://lunrjs.com),
+Copyright (c) 2017 Oliver Nightingale.
+Lunr is distributed under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+So Simple incorporates [Lity](http://sorgalla.com/lity/),
+Copyright (c) 2015-2016, Jan Sorgalla.
+Lity is distributed under the terms of the MIT License](http://opensource.org/licenses/MIT).
+So Simple incorporates [Table of Contents Toggle](https://github.com/smithtimmytim/brightlycolored.org),
+Copyright (c) 2017 Timothy B. Smith.
+Table of Contents Toggle is distributed under the terms of the MIT License](http://opensource.org/licenses/MIT).

data/README.md ADDED Viewed

@@ -0,0 +1,1145 @@
+# [So Simple Jekyll Theme][1]
+[![Gem](https://img.shields.io/gem/v/so-simple-theme.svg?style=flat-square)](https://rubygems.org/gems/jekyll-theme-so-simple)
+[![license](https://img.shields.io/github/license/mmistakes/so-simple-theme.svg?style=flat-square)](LICENSE)
+So Simple is a simple [Jekyll theme](https://jekyllrb.com/docs/themes/) for your words and pictures. Built to provide:
+* A variety of layouts with clean and readable typography.
+* [Microformats](http://microformats.org/wiki/microformats2) markup to make post content machine-readable and discoverable.
+* Disqus Comments and Google Analytics support.
+* SEO best practices via [Jekyll SEO Tag][jekyll-seo-tag].
+* Options to customize the theme and make it your own.
+:sparkles: **See what's new in the [CHANGELOG](CHANGELOG.md).**
+[![So Simple live preview][2]][1]
+![So Simple layouts](screenshots.jpg)
+[1]: https://mmistakes.github.io/so-simple-theme/
+[2]: screenshot.png "site preview"
+## Table of Contents
+1. [Installation](#installation)
+    1. [Ruby Gem Method](#ruby-gem-method)
+    2. [GitHub Pages Method](#github-pages-method)
+        1. [Remove the Unnecessary](#remove-the-unnecessary)
+2. [Upgrading](#upgrading)
+    1. [Ruby Gem](#ruby-gem)
+    2. [Remote Theme](#remote-theme)
+    3. [Use Git](#use-git)
+    4. [Update Files Manually](#update-files-manually)
+3. [Structure](#structure)
+    1. [Starting Fresh](#starting-fresh)
+    2. [Starting from `jekyll new`](#starting-from-jekyll-new)
+4. [Configuring](#configuring)
+    1. [Site Locale](#site-locale)
+    2. [Site URL](#site-url)
+    3. [Site Base URL](#site-base-url)
+    4. [Date Format](#date-format)
+    5. [Reading Time](#reading-time)
+    6. [Mathematics](#mathematics)
+    7. [Google Fonts](#google-fonts)
+    8. [Pagination](#pagination)
+    9. [Search](#search)
+    10. [Taxonomy Pages](#taxonomy-pages)
+    11. [Comments (via Disqus)](#comments-via-disqus)
+    12. [Google Analytics](#google-analytics)
+    13. [Other](#other)
+5. [Layouts](#layouts)
+    1. [`layout: default`](#layout-default)
+    2. [`layout: post`](#layout-post)
+    3. [`layout: page`](#layout-page)
+    4. [`layout: home`](#layout-home)
+    5. [`layout: posts`](#layout-posts)
+    6. [`layout: categories`](#layout-categories)
+    7. [`layout: tags`](#layout-tags)
+    8. [`layout: collection`](#layout-collection)
+    9. [`layout: category`](#layout-category)
+    10. [`layout: tag`](#layout-tag)
+    11. [`layout: search`](#layout-search)
+6. [Images](#images)
+7. [Theme Text](#theme-text)
+8. [Navigation](#navigation)
+9. [Author](#author)
+10. [Footer](#footer)
+    1. [Footer Links](#footer-links)
+    2. [Copyright Text](#copyright-text)
+11. [Helpers](#helpers)
+    1. [Responsive Embed](#responsive-embed)
+    2. [Table of Contents](#table-of-contents)
+12. [Migration Guide](#migration-guide)
+    1. [Global Changes](#global-changes)
+    2. [Browser Support](#browser-support)
+    3. [Configuration Changes](#configuration-changes)
+        1. [Locale Changes](#locale-changes)
+        2. [Owner Changes](#owner-changes)
+        3. [Google Analytics Changes](#google-analytics-changes)
+        4. [Disqus Comments Changes](#disqus-comments-changes)
+    4. [Search Changes](#search-changes)
+    5. [Image Changes](#image-changes)
+    6. [Development Changes](#development-changes)
+    7. [Step-by-Step](#step-by-step)
+13. [Customization](#customization)
+    1. [Overriding Includes and Layouts](#overriding-includes-and-layouts)
+    2. [Customizing Sass (SCSS)](#customizing-sass-scss)
+    3. [Customizing JavaScript](#customizing-javascript)
+14. [Font Awesome Icons](#font-awesome-icons)
+15. [Development](#development)
+    1. [JavaScript Build Script](#javascript-build-script)
+16. [Contributing](#contributing)
+17. [Credits](#credits)
+18. [License](#license)
+## 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**](https://pages.github.com/) you can install as a [remote theme](https://github.com/benbalter/jekyll-remote-theme) or directly copy all of the theme files (see [structure](#structure) below) into your project.
+### Ruby Gem Method
+1. Add this line to your Jekyll site's `Gemfile` (or [create one](example/Gemfile)):
+   ```ruby
+   gem "jekyll-theme-so-simple"
+   ```
+2. Add this line to your Jekyll site's `_config.yml` file:
+   ```yaml
+   theme: jekyll-theme-so-simple
+   ```
+3. Then run [Bundler](http://bundler.io/) to install the theme gem and dependencies:
+   ```terminal
+   bundle install
+   ```
+### 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.
+1. Replace `gem "jekyll"` with:
+   ```ruby
+   gem "github-pages", group: :jekyll_plugins
+   ```
+2. Run `bundle update` and verify that all gems install properly.
+3. Add `remote_theme: "mmistakes/jekyll-theme-so-simple"` to your
+   `_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.
+---
+**Note:** Your Jekyll site should be viewable immediately at <http://USERNAME.github.io>. If it's not, you can force a rebuild by pushing empty commits to GitHub (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 this works, check [GitHub's documentation](https://help.github.com/articles/user-organization-and-project-pages/).
+#### Remove the Unnecessary
+If you forked or downloaded the [`so-simple-theme` repo](https://github.com/mmistakes/so-simple-theme) you can safely remove the following files and folders:
+* `docs/*`
+* `example/*`
+* `.editorconfig`
+* `.gitattributes`
+* `CHANGELOG.md`
+* `Gemfile`
+* `jekyll-theme-so-simple.gemspec`
+* `Rakefile`
+* `README.md`
+* `screenshot.png`
+## Upgrading
+If you're using the Ruby Gem or remote theme versions of So Simple, 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:
+```
+<!--
+    So Simple Jekyll Theme 3.0.0
+    Copyright 2013-2018 Michael Rose - mademistakes.com | @mmistakes
+    Free for personal and commercial use under the MIT license
+    https://github.com/mmistakes/so-simple-theme/blob/master/LICENSE
+-->
+```
+This will be at the top of every `.html` file, `/assets/css/main.css`, and `/assets/js/main.js`.
+### Ruby Gem
+Simply run `bundle update` if you're using Bundler (have a `Gemfile`) or `gem update jekyll-theme-so-simple` if you're not.
+### Remote Theme
+When hosting with [GitHub Pages](https://pages.github.com/) you'll need to push up a commit to force a rebuild with the latest [theme release](https://github.com/mmistakes/so-simple-theme/releases).
+An empty commit will get the job done too if you don't have anything to push at the moment:
+```terminal
+git commit --allow-empty -m "Force rebuild of site"
+```
+### Use Git
+If you want to get the most out of the Jekyll + GitHub Pages workflow, then you'll need to utilize Git. To pull down theme updates manually you must first ensure there's an upstream remote. If you forked the theme's repo then you're likely good to go.
+To double check, run `git remote -v` and verify that you can fetch from `origin https://github.com/mmistakes/so-simple-theme.git`.
+To add it you can do the following:
+```terminal
+git remote add upstream https://github.com/mmistakes/so-simple-theme.git
+```
+#### Pull Down Updates
+Now you can pull any commits made to theme's `master` branch with:
+```terminal
+git pull upstream master
+```
+Depending on the amount of customizations you've made after forking, there's likely to be merge conflicts. Work through any conflicting files Git flags, staging the changes you wish to keep, and then commit them.
+### Update Files Manually
+Another way of dealing with updates is [downloading the theme](https://github.com/mmistakes/so-simple-theme/archive/master.zip) --- replacing your layouts, includes, and assets with the newer ones manually. To be sure that you don't miss any changes review the theme's [commit history](https://github.com/mmistakes/so-simple-theme/commits/master) to see what has changed.
+Here's a quick checklist of the important folders/files you'll want to be mindful of:
+| Name                   |                                                                                |
+| ---------------------- | ------------------------------------------------------------------------------ |
+| `_layouts`             | Replace all. Apply edits if you customized any layouts.                        |
+| `_includes`            | Replace all. Apply edits if you customized any includes.                       |
+| `assets`               | Replace all. Apply edits if you customized stylesheets or scripts.             |
+| `_sass`                | Replace all. Apply edits if you customized Sass partials.                      |
+| `_data/navigation.yml` | Safe to keep. Verify that there were no major structural changes or additions. |
+| `_data/text.yml`       | Safe to keep. Verify that there were no major structural changes or additions. |
+| `_config.yml`          | Safe to keep. Verify that there were no major structural changes or additions. |
+---
+**Note:** If you're not seeing the latest version, be sure to flush browser and CDN caches. Depending on your hosting environment older versions of `/assets/css/main.css`, `/assets/js/main.min.js`, or `*.html` files may be cached.
+## Structure
+Layouts, includes, Sass partials, and data files are all placed in their default locations. Stylesheets and scripts can be found in `assets`, and a few development related files in the project's root directory.
+**Please note:** If you installed So Simple via the Ruby Gem or remote theme methods, theme files found in `/_layouts`, `/_includes`, `/_sass`, and `/assets` will be missing from your project. This is normal as they are bundled with the [`jekyll-theme-so-simple`](https://rubygems.org/gems/jekyll-theme-so-simple) gem.
+```
+├── _data               # data files
+|  └── text.yml         # theme text
+├── _includes           # theme includes
+├── _layouts            # theme layouts (see below for usage)
+├── _sass               # Sass partials
+├── assets
+|  ├── css
+|  |  └── main.scss
+|  └── js
+|     └── main.min.js
+├── _config.yml         # sample configuration
+└── index.md            # sample home page (recent posts/not paginated)
+```
+### Starting Fresh
+After creating a `Gemfile` and installing the theme you'll need to add and edit the following files:
+* [`_config.yml`](_config.yml)
+* [`/_data/text.yml`](_data/text.yml)
+* [`index.md`](index.md)
+**Note:** Consult the [**pagination**](#pagination) documentation below for instructions on how to enable it on the home page.
+### Starting from `jekyll new`
+Using the `jekyll new` command will get you up and running the quickest.
+Edit your `Gemfile` and `_config.yml` files following the [installation guide](#installation) above and [configuration guide](#configuring) below, then create `_data/text.yml` as instructed earlier.
+## Configuring
+Configuration of site-wide elements (`locale`, `title`, `description`, `url`, `logo`, `author`, etc.) happens in your project's `_config.yml`. See the [example configuration](example/_config.yml) in this repo for additional reference.
+| Name          | Description                                                              | Example                             |
+| ------------- | ------------------------------------------------------------------------ | ----------------------------------- |
+| `locale`      | Primary language for the site.                                           | `"en-us"`                           |
+| `title`       | Site's title.                                                            | `"My Awesome Site"`                 |
+| `description` | A short description.                                                     | `"This is my site, it is awesome."` |
+| `baseurl`     | Used to test the website under the same base url it will be deployed to. | `/my-base-path`                     |
+| `url`         | The full URL to your site.                                               | `"https://your-site.com"`           |
+| `logo`        | Path to a site-wide logo used in masthead.                                | `/images/your-logo.png`             |
+### Site Locale
+**`site.locale`** is used to declare the primary language for each web page within the site.
+_Example:_ locale: `"en-US"` sets the lang attribute for the site to the United States flavor of English, while `en-GB` would be for the United Kingdom style of English. Country codes are optional and the shorter variation `locale: "en"` is also acceptable. To find your language and country codes check this [reference table](<https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx>).
+Properly setting the locale is important for associating localized text found in the text data file.
+**Note:** The theme defaults to text in English (`en`, `en-US`, `en-GB`). If you change locale in `_config.yml` to something else be sure to add the corresponding locale key and translated text to [`_data/text.yml`](_data/text.yml).
+### Site URL
+The base hostname and protocol for your site. If you're hosting with GitHub Pages this will be something like `url: "https://github.io.mmistakes"` or `url: "https://your-site.com"` if you have a custom domain name.
+GitHub Pages now [forces `https://` for new sites](https://help.github.com/articles/securing-your-github-pages-site-with-https/), so be mindful of that when setting your URL to avoid mixed-content warnings.
+**Note:** Jekyll overrides the value of `url` with `http://localhost:4000` when running `jekyll serve` locally in development. If you want to avoid this behavior set `JEKYLL_ENV=production` to [force the environment](http://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time) to production.
+### Site Base URL
+This option causes all kinds of confusion in the Jekyll community. If you're not hosting your site as a [GitHub Project Page](https://help.github.com/articles/user-organization-and-project-pages/) or in a subfolder (e.g., `/blog`), then don't mess with it.
+In the case of the **So Simple** demo site it's hosted on GitHub at <https://mmistakes.github.io/so-simple-theme>. To correctly set this base path I'd use `url: "https://mmistakes.github.io"` and `baseurl: "/so-simple-theme"`.
+For more information on how to properly use `site.url` and `site.baseurl` as intended by the Jekyll maintainers, check [Parker Moore's post on the subject](https://byparker.com/blog/2014/clearing-up-confusion-around-baseurl/).
+**Note:** When using `baseurl` remember to include it as part of your link and asset paths in your content. Values of `url:` and `baseurl: "/blog"` would make your local site visible at <http://localhost:4000/blog> and not <http://localhost:4000>. You can either prepend all your asset and internal link paths with `{{ site.baseurl }}` or use Jekyll's `relative_url`.
+To use the example values above the following image path of `{{ '/images/my-image.jpg' | relative_url }}` would output correctly as `http://localhost:4000/blog/images/my-image.jpg`.
+Without the `relative_url` filter that asset path would be missing `/blog` and you'd have a broken image on your page.
+### Date Format
+You can change the default date format by specifying `date_format` in `_config.yml`. It accepts any of the standard [Liquid date formats](http://shopify.github.io/liquid/filters/date/).
+For example the default value of `"%B %-d, %Y"` could be changed like so:
+```yaml
+date_format: "%Y-%m-%d"
+```
+### Reading Time
+Enable estimated reading time snippets site-wide with `read_time: true`. **`200`** has been set as the default words per minute value — which can be changed via `words_per_minute` in your `_config.yml` file.
+```yaml
+read_time: true
+words_per_minute: 200
+```
+### Mathematics
+Enable [**MathJax**](https://www.mathjax.org) (a JavaScript display engine for mathematics) site-wide with `mathjax: true`.
+### Google Fonts
+Easily use [**Google Fonts**](https://fonts.google.com/) throughout your site by replacing the font `name` and `weights` accordingly. Suggested font pairings are as follows:
+```yaml
+google_fonts:
+  - name: "Source Sans Pro"
+    weights: "400,400i,700,700i"
+  - name: "Lora"
+    weights: "400,400i,700,700i"
+```
+**Note:** If other font families are used, be sure to add, then override the following SCSS variables in `/assets/css/main.scss` with the `font-family` values Google provides.
+```scss
+$serif-font-family: "Lora", serif;
+$sans-serif-font-family: "Source Sans Pro", sans-serif;
+$monospace-font-family: Menlo, Consolas, Monaco, "Courier New", Courier,
+  monospace;
+$base-font-family: $sans-serif-font-family;
+$headline-font-family: $sans-serif-font-family;
+$title-font-family: $serif-font-family;
+$description-font-family: $serif-font-family;
+$meta-font-family: $serif-font-family;
+```
+See [stylesheet documentation](#customizing-sass-scss) below for more information on overriding the theme's default variables.
+### Pagination
+Break up the main listing of posts on the home page across multiple pages by [enabling pagination](http://jekyllrb.com/docs/pagination/).
+1. Include the [`jekyll-paginate`][jekyll-paginate] plugin in your `Gemfile`.
+   ```ruby
+   group :jekyll_plugins do
+     gem "jekyll-paginate"
+   end
+   ```
+2. Add `jekyll-paginate` to the `plugins` array (previously `gems`) in your `_config.yml` file and the following pagination settings:
+   ```yaml
+   paginate: 10  # amount of posts to show per page
+   paginate_path: /page:num/
+   ```
+3. Create `index.html` (or rename `index.md`) in the root of your project and add the following front matter:
+   ```yaml
+   layout: home
+   paginate: true
+   ```
+### Search
+To index the full content of your documents for use in a [search page](#layout-search), set `search_full_content` to `true` in `_config.yml`:
+```yaml
+search_full_content: true
+```
+**Note:** Large amounts of posts will increase the size of the search index, impacting page load performance. Setting `search_full_content` to `false` (the default) restricts indexing to the first 50 words of body content.
+### Taxonomy Pages
+By default, category and tags added to a post are not linked to taxonomy archive pages. To enable this behavior and link to pages with posts grouped by category or tag, add the following:
+```yaml
+category_archive_path: "/categories/#"
+tag_archive_path: "/tags/#"
+```
+These paths should mimic the permalinks used for your [**categories**](#layout-categories) and [**tags archive**](#layout-tags) pages. The `#` at the end is necessary to target the correct taxonomy section on the pages.
+For example if you were to create `categories.md` with the following front matter:
+```yaml
+title: Categories Archive
+layout: categories
+permalink: /foo/
+```
+You'd need to change `category_archive_path` to `"/foo/#` for category links to function properly.
+**Note:** You can create dedicated category and tag pages manually with [`layout: category`](#layout-category) and [`layout: tag`](#layout-tag). Or use plugins like [**jekyll-archives**][jekyll-archives] or [**jekyll-paginate-v2**](https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-AUTOPAGES.md) to generate them automatically.
+### Comments (via Disqus)
+If you have a [**Disqus**](https://disqus.com/) account, you can show a comments section below each post.
+To enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208) to your project's `_config.yml` file:
+```yaml
+disqus:
+  shortname: my_disqus_shortname
+```
+Comments only appear in production when built with the following [environment value](http://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time): `JEKYLL_ENV=production` to avoid polluting your Disqus account with `localhost` content.
+If you don't want to display comments for a particular post you can disable them by adding `comments: false` to that post's front matter.
+### Google Analytics
+To enable [**Google Analytics**](https://analytics.google.com/analytics/web/), add your tracking ID to `_config.yml` like so:
+```yaml
+google_analytics: UA-NNNNNNNN-N
+```
+Similar to Disqus comments above, the Google Analytics tracking script will only appear in production when using the following environment value: `JEKYLL_ENV=production`.
+### Other
+For more configuration options be sure to consult the documentation for:
+[**jekyll-seo-tag**][jekyll-seo-tag], [**jekyll-feed**][jekyll-feed],
+[**jekyll-paginate**][jekyll-paginate], and [**jekyll-sitemap**][jekyll-sitemap].
+---
+## Layouts
+This theme provides the following layouts, which you can use by setting the `layout` [front matter](https://jekyllrb.com/docs/frontmatter/) on each page, like so:
+```yaml
+---
+layout: name
+---
+```
+### `layout: default`
+This layout handles all of the basic page scaffolding placing the page content between the masthead and footer elements. All other layouts inherit this one and provide additional styling and features inside of the `{{ content }}` block.
+### `layout: post`
+This layout accommodates the following front matter:
+| Name | Type | Description |
+| ---- | ----- | ---------- |
+| `image` | String | Path to a large image associated with the post. Also used for [OpenGraph](http://ogp.me/), [Twitter Cards](https://dev.twitter.com/cards), and site feed thumbnail if enabled. [Suggested image sizes](#images). |
+| `image.path` | String | Same as above. Used when a `thumbnail` or `caption` needs to be assigned to the `image` object as well. |
+| `image.caption` | String | Describes the image or provides credit. Markdown is allowed. |
+| `author` | Object or string | Specify a post's author `name`, `picture`, `twitter`, `links`, etc. |
+| `comments` | Boolean | Disable comments with `comments: false`. |
+| `share` | Boolean | Add social share links to a post with `share: true`. |
+**Post image example:**
+```yaml
+image:
+  path: /images/post-image-lg.jpg
+  thumbnail: /images/post-image-th.jpg
+  caption: "Photo credit [Unsplash](https://unsplash.com/)
+```
+**Note:** `image.feature` front matter has been deprecated, to fully support [jekyll-seo-tag][jekyll-seo-tag]. If you are not using `thumbnail` or `caption` the post image can be assigned more concisely as `image: /images/your-post-image.jpg`.
+**Post author example:**
+```yaml
+# post specific author data if different from what is set in _config.yml
+author:
+  name: John Doe
+  picture: /images/john-doe.jpg
+  twitter: johndoe
+```
+**Note:** Author information can centralized in `_data/authors.yml` by doing following in the document's front matter:
+```yaml
+author: johndoe
+```
+With the corresponding author key in `_data/authors.yml`:
+```yaml
+johndoe:
+  name: John Doe
+  picture: /images/john-doe.jpg
+  twitter: johndoe
+```
+**Note:** `author.picture` recommended size is `150 x 150` pixels.
+#### Author Links
+To define what links appear in the author sidebar use the `authors.links` key in either `_config.yml` or `/_data/authors.yml`.
+| Name    | Description                                                                                                      |
+| ------- | ---------------------------------------------------------------------------------------------------------------- |
+| `title` | Describes the link. Not visible, used for accessibility purposes.                                                |
+| `url`   | URL the link points to.                                                                                          |
+| `icon`  | Corresponds with a [Font Awesome icon](https://fontawesome.com/icons?d=gallery) e.g., `fab fa-twitter-square`.   |
+**Example:**
+```yaml
+author:
+  links:
+    - title: Twitter
+      url: https://twitter.com/username
+      icon: fab fa-twitter-square
+    - title: Instagram
+      url: https://instagram.com/username
+      icon: fab fa-instagram
+    - title: GitHub
+      url: https://github.com/username
+      icon: fab fa-github-square
+```
+### `layout: page`
+Visually this layout looks and acts similar `layout: post`, with the following
+differences.
+* Author sidebar and page meta (published date, categories, and tags) are ommitted.
+* Page is less wide due to omitted sidebar.
+* Disqus comments are omitted.
+* Next/Previous post navigation links omitted.
+The page layout forms the base for several other layouts like [`home`](#layout-home), [`posts`](#layout-posts), [`categories`](#layout-categories), [`tags`](#layout-tags), [`collection`](#layout-collection), [`category`](#layout-category), [`tag`](#layout-tag), and [`search`](#layout-search).
+### `layout: home`
+This layout accommodates the same front matter as `layout: page`, with the
+addition of the following:
+```yaml
+paginate: true  # enables pagination loop, see section above for additional setup
+entries_layout: # list (default), grid
+```
+When not enabled the page defaults to showing the latest 10 posts. To change the amount of posts shown, you can edit or override the `limit` value in [`/_includes/posts-limit.html`](_includes/posts-limit.html).
+```liquid
+{% for entry in site.posts limit: 10 %}
+  {% include entry.html %}
+{% endfor %}
+```
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+### `layout: posts`
+This layout displays all posts grouped by the year they were published. It accommodates the same front matter as `layout: page`.
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+### `layout: categories`
+This layout displays all posts grouped category. It accommodates the same front matter as `layout: page`.
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+### `layout: tags`
+This layout displays all posts grouped by tag. It accommodates the same front matter as `layout: page`.
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+### `layout: collection`
+This layout displays all documents grouped by a specific collection. It accommodates the same front matter as `layout: page` with the addition of the following:
+```yaml
+collection: # collection name
+entries_layout: # list (default), grid
+```
+To create a page showing all documents in the `recipes` collection you'd create `recipes.md` in the root of your project and add this front matter:
+```yaml
+title: Recipes
+layout: collection
+permalink: /recipes/
+collection: recipes
+```
+By default, documents are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+### `layout: category`
+This layout displays all posts grouped by a specific category. It accommodates the same front matter as `layout: page` with the addition of the following:
+```yaml
+taxonomy: # category name
+entries_layout: # list (default), grid
+```
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+To create a page showing all posts assigned to the category `foo` you'd create `foo.md` in the root of your project and add this front matter:
+```yaml
+title: Foo
+layout: category
+permalink: /categories/foo/
+taxonomy: foo
+```
+### `layout: tag`
+This layout displays all posts grouped by a specific tag. It accommodates the same front matter as `layout: page` with the addition of the following:
+```yaml
+taxonomy: # tag name
+entries_layout: # list (default), grid
+```
+By default, posts are shown in a list view. To change to a grid view add `entries_layout: grid` to the page's front matter.
+To create a page showing all posts assigned to the tag `foo bar` you'd create `foo-bar.md` in the root of your project and add this front matter:
+```yaml
+title: Foo Bar
+layout: tag
+permalink: /tags/foo-bar/
+taxonomy: foo bar
+```
+### `layout: search`
+This layout displays a search form and displays related pages based on the query.
+Page content index: `title`, `excerpt`, `content` (when enabled), `categories`, `tags`, and `url`.
+If you would like to exclude specific pages/posts from the search index set the search flag to `false` in their front matter.
+```yaml
+search: false
+```
+To index the full content of your documents set `search_full_content` to `true` in `_config.yml`:
+```yaml
+search_full_content: true
+```
+**Note:** Large amounts of posts will increase the size of the search index, impacting page load performance. Setting `search_full_content` to `false` (the default) restricts indexing to the first 50 words of body content.
+## Images
+Suggested image sizes in pixels are as follows:
+| Image | Description | Size |
+| ----- | ----------- | ---- |
+| `site.logo` | Site-wide logo used in masthead. | `200 x 200` |
+| `page.image.path` | Large full-width document image. | Tall images will push content down the page. `1600 x 600` is a good middle-ground size to aim for. |
+| `page.image` | Short-hand for `page.image.path` when used alone (without `thumbnail`, `caption`, or other variables). | Same as `page.image.path` |
+| `page.image.thumbnail` | Small document image used in grid view. | `400 x 200` |
+| `author.picture` | Author picture in post sidebar. | `150 x 150` |
+## Theme Text
+To change text found throughout the theme, copy the following
+[`/_data/theme.yml`](_data/text.yml) file and customize as necessary.
+When adding new texts be sure the keys match these [language/country codes](<https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx>), that may be used for [`site.locale`](#site-locale).
+## Navigation
+To define what pages are linked in the top navigation:
+1. Create a [`/_data/navigation.yml`](_data/navigation.yml) file.
+2. Add pages in the order you'd like them to appear:
+   ```yaml
+   - title: Posts
+     url: /posts/
+   - title: Categories
+     url: /categories/
+   - title: External Page
+     url: https://whatever-site.com/page.html
+   - title: Search
+     url: /search/
+   ```
+**Note:** Long titles or many links may cause the navigation bar to break into multiple lines, especially on smaller screens. Keep this in mind as you develop your site's primary navigation.
+## Author
+Author information is used as meta data for post "by lines" and propagates the `creator` field of Twitter summary cards with the following front matter in `_config.yml`:
+```yaml
+author:
+  name: John Doe
+  twitter: johndoetwitter
+  picture: /images/johndoe.png
+```
+Site-wide author information can be overridden in a document's front matter in the same way:
+```yaml
+author:
+  name: Jane Doe
+  twitter: janedoetwitter
+  picture: /images/janedoe.png
+```
+Or by specifying a corresponding key in the document's front matter, that exists in `site.data.authors`. E.g., you have the following in the document's front matter:
+```yaml
+author: megaman
+```
+And you have the following in `_data/authors.yml`:
+```yaml
+megaman:
+  name: Mega Man
+  twitter: megamantwitter
+  picture: /images/megaman.png
+drlight:
+  name: Dr. Light
+  twitter: drlighttwitter
+  picture: /images/drlight.png
+```
+Currently `author.picture` is only used in `layout: post`. Recommended size is `150 x 150` pixels.
+## Footer
+The footer links and copyright text can both be customized.
+### Footer Links
+Footer links are set in `_config.yml` under the `footer_links` key.
+| Name    | Description                                                                                                      |
+| ------- | ---------------------------------------------------------------------------------------------------------------- |
+| `title` | Describes the link. Not visible, used for accessibility purposes.                                                |
+| `url`   | URL the link points to.                                                                                          |
+| `icon`  | Corresponds with a [Font Awesome 5 icon](https://fontawesome.com/icons?d=gallery) e.g., `fab fa-twitter-square`. |
+**Examples:**
+```yaml
+footer_links:
+  - title: Twitter
+    url: https://twitter.com/username
+    icon: fab fa-twitter-square
+  - title: GitHub
+    url: https://github.com/mmistakes
+    icon: fab fa-github-square
+  - title: Feed
+    url: atom.xml
+    icon: fas fa-rss-square
+```
+### Copyright Text
+By default the copyright inserts the current year, [`site.title`](#site-title), and the words `"Powered by Jekyll & So Simple."` To change this add `copyright` to your `_config.yml` like so (Markdown is allowed):
+```yaml
+copyright: "This site is made with <3 by *me, myself, and I*."
+```
+## Helpers
+You can think of these Jekyll helpers as shortcodes. Since GitHub Pages doesn't allow most plugins --- [custom tags](https://jekyllrb.com/docs/plugins/#tags) are out. Instead the theme leverages [**includes**](https://jekyllrb.com/docs/templates/#includes) to do something similar.
+### Responsive Embed
+Embed a video from YouTube/Vimeo or any other `iframe` content that responsively sizes to fit the width of its parent.
+| Parameter | Required | Description |
+| --------- | -------- | ----------- |
+| `url`     | Yes      | Video or iframe's URL e.g., `https://www.youtube.com/watch?v=-PVofD2A9t8` |
+| `ratio`   | Optional | Ratio of the video or iframe content. `21:9`, `16:9`, `4:3`, `1:1`. If a ratio is not assigned `16:9` is used. |
+**Example:**
+```html
+{% include responsive-embed url="https://www.youtube.com/watch?v=-PVofD2A9t8" ratio="16:9" %}
+```
+### Table of Contents
+To include an [auto-generated table of contents](https://kramdown.gettalong.org/converter/html.html#toc) for posts and pages, add the following helper where you'd like it to appear.
+```html
+{% include toc %}
+```
+## Migration Guide
+So Simple 3 is a major rewrite of the entire theme. The most notable changes are summarized below, followed by more specific changes.
+It is safe to say you'll probably want to ditch all `_layouts`, `_includes`, `_sass`, `.css`, and `.js` files from v2 and use either the [Ruby gem](#ruby-gem-method) or [remote theme](github-pages-method) installation options.
+### Global Changes
+* "Fork method" has been deprecated in favor of installing/upgrading the theme via a gem or remote theme.
+* All `_layouts`, `_includes`, `_sass`, and JavaScript have been rebuilt.
+* Properly uses `site.url` and `site.baseurl` leveraging the `relative_url` and `absolute_url` filters.
+* Replaced custom `/_includes/open-graph.html` with [**jekyll-seo-tag**][jekyll-seo-tag].
+* Full control over links and icons used in author sidebar and footer.
+* Tag, articles, and blog starter pages have been replaced with new layouts ([`tags`](#layout-tags) and [`posts`](#layout-posts)) for easier use.
+* Removed `404.md` page.
+* Replaced custom `atom.xml` feed file with [**jekyll-feed**][jekyll-feed].
+* Removed default `favicon.ico` and `favicon.png` files.
+* Replaced simple JSON search with [**Lunr**](https://lunrjs.com/).
+* Replaced [Magnific Popup](http://dimsemenov.com/plugins/magnific-popup/) with [**Lity**](https://sorgalla.com/lity/).
+* Removed [FitVids.JS](http://fitvidsjs.com/).
+### Browser Support
+* CSS written with modern browsers in mind. Where possible fallbacks for `float` based layouts have been used so things don't look *too broken* in browsers that don't support `display: grid` and flexbox.
+### Configuration Changes
+#### Locale Changes
+Format has changed from `en_US` (with an underscore) to `en-US` with a hyphen.
+#### Owner Changes
+`site.owner` is now `site.author` to better support [jekyll-seo-tag][jekyll-seo-tag] and [jekyll-feed][jekyll-feed].
+| v2                            | v3                                                             |
+|-------------------------------|----------------------------------------------------------------|
+| `site.owner.name`             | **`site.author.name`**                                         |
+| `site.owner.avatar`           | **`site.author.picture`**                                      |
+| `site.owner.email`            | **`site.author.email`**                                        |
+| `site.owner.twitter`          | **`site.twitter`**                                             |
+| `site.owner.google.analytics` | **deprecated**, replaced with [jekyll-seo-tag][jekyll-seo-tag] |
+| `site.owner.bing-verify`      | **deprecated**, replaced with [jekyll-seo-tag][jekyll-seo-tag] |
+#### Google Analytics Changes
+`site.owner.google.analytics` is now `site.google_analytics`. [See documentation](#google-analytics) for more information.
+#### Disqus Comments Changes
+`site.owner.disqus-shortname` is now `site.disqus.shortname`. [See documentation](#comments-via-disqus) more information.
+To disable comments on a particular post add `comments: false` to its front matter.
+### Search Changes
+`search_omit` has been renamed to `search`. To exclude a post or page from search add `search: false` to its front matter instead.
+### Image Changes
+When assigning image paths for things like the `site.logo`, `page.image.path`, `author.picture`, etc. they now require a full relative or absolute path.
+In So Simple v2 images were all placed in `/images/` and assigned in front matter with just the filename. For images to properly load, you now need to prepend all paths with `/images/`... if you are storing images there e.g., `/images/your-image.jpg`.
+To better support Jekyll plugin's like [jekyll-seo-tag][jekyll-seo-tag], [jekyll-feed][jekyll-feed], and [jekyll-sitemap][jekyll-sitemap] most of the `image` keys have been renamed. Adjust the front matter in all of your posts' and pages' accordingly.
+| v2                 | v3                                         |
+|--------------------|--------------------------------------------|
+| `image.feature`    | **`image.path`**                           |
+| `image.thumb`      | **`image.thumbnail`**                      |
+| `image.credit`     | **`image.caption`** (Markdown allowed)     |
+| `image.creditlink` | deprecated use `**image.caption**` instead |
+A post with the following v2 front matter:
+```yaml
+image:
+  feature: feature-image-filename.jpg
+  thumb: thumb-image-filename.jpg
+  credit: Michael Rose
+  creditlink: https://mademistakes.com
+```
+Would be converted into the following v3 front matter:
+```yaml
+image:
+  path: /images/feature-image-filename.jpg
+  thumbnail: /images/thumb-image-filename.jpg
+  caption: "[Michael Rose](https://mademistakes)"
+```
+### Development Changes
+* Replaced Grunt tasks with [npm scripts](https://css-tricks.com/why-npm-scripts/).
+### Step-by-Step
+Rough steps to migrate a stock So Simple v2 fork (with no alterations) to the latest.
+1. Remove `_includes/`, `_layouts/`, `_sass/`, `jshintrc`, `Gruntfile.js`, and `search.json`.
+2. Edit `Gemfile` for either the [Ruby gem](#ruby-gem-method) or [GitHub Pages](#github-pages-method) installation methods and follow those instructions.
+3. Add the following Google Fonts to `_config.yml`:
+   ```yaml
+   google_fonts:
+     - name: "Source Sans Pro"
+       weights: "400,400i,700,700i"
+     - name: "Lora"
+       weights: "400,400i,700,700i"
+   ```
+4. Edit `_config.yml` paying close attention to those keys that [have been renamed](#configuration-changes) or have new relative path requirements. `locale`, `logo`, and `owner` are good places to start.
+5. Rename all instances of `image.feature`, `image.thumb`, and `image.credit` in posts/pages adhering to the [image changes](#image-changes) above.
+6. Remove the body content in `index.html` and change `layout: page` to `layout: home`. Configure [pagination](#pagination) if necessary.
+7. Remove the body content in `/search/index.md` and change `layout: page` to **`layout: search`**.
+8. Remove the body content in `/tags/index.md` and change `layout: page` to **`layout: tags`**.
+9. Remove the body content in `/articles/index.md` and change `layout: page` to **`layout: category`** and add **`taxonomy: articles`**.
+10. Remove the body content in `/body/index.md` and change `layout: page` to **`layout: category`** and add **`taxonomy: blog`**.
+11. Rename `modified` front matter in posts/pages to **`last_modified_at`** for improved parity with plugins that support it.
+12. Add `tag_archive_path: "/tags/#"` to `_config.yml` to activate tag links in post meta sidebar.
+13. Rename `avatar` to **`picture`** in `_data/authors.yml` (and in any posts/pages front matter), and edit the paths adhering to the [image path changes](#image-changes) above.
+---
+## Customization
+When installing as a **Ruby gem** or **remote theme** the core theme files (`_layouts`, `_includes`, `_sass`, `assets`, etc.) will be absent from your project.
+The default structure, style, and scripts of this theme can be overridden and customized in the following two ways:
+### Overriding Includes and Layouts
+Theme files can be [overridden](http://jekyllrb.com/docs/themes/#overriding-theme-defaults) by placing a file with the same name into your project's `_includes` or `_layouts` directory. For instance:
+* To add another social sharing button to [`_includes/social-share.html`](_includes/social-share.html), create an `_includes` directory in your project, copy `_includes/social-share.html` from So Simple's gem folder to `<your_project>/_includes` and edit that file.
+**ProTip:** to locate the theme's files on your computer run `bundle show jekyll-theme-so-simple`. This returns the location of the gem-based theme files.
+The theme comes with two files to help inject custom markup and content into predefined locations.
+|     | Description |
+| --- | ----------- |
+| [`_includes/head-custom.html`](_includes/head-custom.html) | Inserted inside the `<head>` element for adding metadata, favicons, etc. |
+| [`_includes/footer-custom.html`](_includes/footer-custom.html) | Inserted inside the `<footer>` element before site scripts and copyright information. |
+### Customizing Sass (SCSS)
+To override the default [Sass](http://sass-lang.com/guide) (located in theme's
+`_sass` directory), do one of the following:
+1. Copy directly from the So Simple gem
+   * Go to your local So Simple gem installation directory (run
+     `bundle show jekyll-theme-so-simple` to get the path to it).
+   * Copy the contents of `/assets/css/main.scss` from there to
+     `<your_project>`.
+   * Customize what you want inside `<your_project>/assets/stylesheets/main.scss`.
+2. Copy from this repo.
+   * Copy the contents of [assets/css/main.scss](assets/css/main.scss) to `<your_project>`.
+   * Customize what you want inside `<your_project/assets/stylesheets/main.scss`.
+**Note:** To customize the actual Sass partials bundled
+in the gem, you will need to copy the complete contents of the `_sass` directory to `<your_project>`. Due to the way Jekyll currently imports these files it's all or nothing. Overriding a single Sass partial (or two) won't work like `_includes` and `_layouts`.
+To make basic tweaks to theme's style, Sass variables can be overridden by adding to `<your_project>/assets/stylesheets/main.scss`. For instance, to change the accent color used throughout the theme add the following after all `@import` lines:
+```scss
+$accent-color: tomato;
+```
+### Customizing JavaScript
+To override the default JavaScript bundled in the theme, do one of the following:
+1. Copy directly from the So Simple gem
+   * Go to your local So Simple gem installation directory (run
+     `bundle show jekyll-theme-so-simple` to get the path to it).
+   * Copy the contents of `/assets/js/main.js` from there to
+     `<your_project>`.
+   * Customize what you want inside `<your_project>/assets/js/main.js`.
+2. Copy from this repo.
+   * Copy the contents of [`/assets/js/main.js`](assets/js/main.js)
+     to `<your_project>`.
+   * Customize what you want inside `<your_project>/assets/js/main.js`.
+The theme's [`/assets/js/main.min.js`](assets/js/main.min.js) file is built from jQuery plugins and other scripts found in [`/assets/js/`](assets/js).
+```
+├── assets
+|  ├── js
+|  |  ├── lunr                             # Lunr search plugin
+|  |  |   ├── lunr.xx.js                   # Lunr language plugins
+|  |  |   ├── ...
+|  |  |   ├── lunr.min.js
+|  |  |   └── lunr.stemmer.support.min.js
+|  |  ├── plugins
+|  |  |   ├── jquery.smooth-scroll.min.js  # make same-page links scroll smoothly
+|  |  |   ├── lity.min.js                  # responsive lightbox
+|  |  |   └── table-of-contents.js         # table of contents toggle
+|  |  ├── main.js                          # jQuery plugin settings and other scripts
+|  |  ├── main.min.js                      # concatenated and minified scripts
+|  |  ├── search-data.json                 # search index used by Lunr
+```
+To modify or add your own scripts, include them in `assets/js/main.js` and then rebuild using `npm run build:js`. [See below for more details](#javascript-build-script).
+If you add additional scripts to `/assets/js/plugins/` and would like them concatenated with the others, be sure to update the `uglify` script in [`package.json`](package.json). Same goes for scripts that you remove.
+You can also add scripts to the `<head>` or closing `</body>` elements by adding paths to the following arrays in `_config.yml`.
+**Example:**
+```yaml
+head_scripts:
+  - https://code.jquery.com/jquery-3.2.1.min.js
+  - /assets/js/your-custom-head-script.js
+footer_scripts:
+  - /assets/js/your-custom-footer-script.js
+```
+**Note:** If you assign paths to `footer_scripts` the theme's `/assets/js/main.min.js` file will be deactivated. This script includes plugins and other scripts that will cease to function unless you specifically add them to the `footer_scripts` array.
+## Font Awesome Icons
+The theme utilizes the [**Font Awesome** SVG with JS](https://fontawesome.com/) version for iconography. Prominent locations these icons appear are in the author sidebar and footer links.
+---
+## Development
+To set up your environment to develop this theme:
+1. Clone this repo
+2. `cd` into `/example` and run `bundle install`.
+To test the theme locally as you make changes to it:
+1. `cd` into the root folder of the repo (e.g. `jekyll-theme-so-simple`).
+2. Run `bundle exec rake preview` and open your browser to
+   `http://localhost:4000/example/`.
+This starts a Jekyll server using the theme's files and contents of the `example/` directory. As modifications are made, refresh your browser to see any changes.
+### JavaScript Build Script
+In an effort to reduce dependencies a set of [npm scripts](https://css-tricks.com/why-npm-scripts/) are used to build `main.min.js` instead of task runners like [Gulp](http://gulpjs.com/) or [Grunt](http://gruntjs.com/). If those tools are more your style then by all means use them instead :wink:.
+To get started:
+1. Install Node.js.
+2. `cd` to the root of your project.
+3. Install all of the dependencies by running npm install.
+**Note:** If you upgraded from a previous version of the theme be sure you copied over [`package.json`](package.json) prior to running `npm install`. You may also need to remove your `node_modules` directory as well.
+If all goes well, executing `npm run build:js` will compress/concatenate `main.js` and all plugin scripts into `/assets/js/main.min.js`.
+## Contributing
+Found a typo in the documentation? Requesting a feature or
+[bug fix][issues]? Search through the open and closed issues before [submitting an issue][new-issue] to avoid duplication.
+[Pull requests][using-pull-requests] are also appreciated. If this is your first time, it may be helpful to read up on the [GitHub Flow][github-flow].
+If your contribution adds or changes the theme's behavior, make sure to update the documentation and/or sample content. Documentation lives in README.md while sample posts, pages, and collections are in the [`docs`](docs) and [`example`](example) folders.
+[issues]: https://github.com/mmistakes/so-simple-theme/issues
+[new-issue]: https://github.com/mmistakes/so-simple-theme/issues/new
+[using-pull-requests]: https://help.github.com/articles/using-pull-requests/
+[github-flow]: https://guides.github.com/introduction/flow/
+### Pull Requests
+When submitting a pull request:
+1. Clone the repo.
+2. Create a branch off of `master` and give it a meaningful name (e.g.
+   `my-awesome-new-feature`).
+3. Open a pull request on GitHub and describe what problem it solves.
+---
+## Credits
+### Creator
+**Michael Rose**
+* <https://mademistakes.com>
+* <https://twitter.com/mmistakes>
+* <https://github.com/mmistakes>
+### Icons + Demo Images:
+* [Font Awesome](https://fontawesome.com)
+* [WeGraphics](http://wegraphics.net/downloads/free-ultimate-blurred-background-pack/)
+* [Unsplash](https://unsplash.com/)
+### Other:
+* [Jekyll](http://jekyllrb.com/)
+* [Breakpoint](http://breakpoint-sass.com/)
+* [jQuery](http://jquery.com/)
+* [jQuery Smooth Scroll](https://github.com/kswedberg/jquery-smooth-scroll)
+* [Lity](https://sorgalla.com/lity/)
+* [Lunr](http://lunrjs.com/)
+---
+## License
+The theme is available as open source under the terms of the [MIT License](LICENSE).
+[jekyll-seo-tag]: https://github.com/jekyll/jekyll-seo-tag
+[jekyll-feed]: https://github.com/jekyll/jekyll-feed
+[jekyll-paginate]: https://github.com/jekyll/jekyll-paginate
+[jekyll-sitemap]: https://github.com/jekyll/jekyll-sitemap
+[jekyll-archives]: https://github.com/jekyll/jekyll-archives