minimal-mistakes/CHANGELOG.md
Michael Rose 3e347970c7 Add vertical scrollbar to sidebars that extend outside the viewport
Viewing overflowing sidebar content requires scrolling the entire page which is annoying and causes the reader to lose their place.

Use CSS `calc` to approximate height of the sidebar (`100vh` - height of the masthead) and apply `overflow-y: auto` to add vertical scrollbars when needed.

Fixes #706
2017-07-12 12:03:14 -04:00

38 KiB

Unreleased

Enhancements

  • Add scrollbar to sidebars with overflowing content that extends outside the viewport's height. #706

4.4.2

Enhancements

  • Add Swedish, Dutch, and Indonesian localized UI text strings. #996 #1081 #1101
  • Add Bitbucket social icon color. #1009
  • Add GitLab to author sidebar. #1050
  • Add Sass variable for navicon link hover color. #1089 #1088

Bug Fixes

  • Toggle close button on mouseleave. #975
  • Remove extraneous </a> and </li> tags from paginator.html include. #1038
  • Fix Google+ comments provider includes. #1092
  • Replace category variable used in _includes/breadcrumbs.html to site.category_archive to avoid conflicts with site.categories. #1063 #329

Maintenance

  • Add mention of Greek localized UI text strings to theme documentation. #972
  • Update Greek localized UI text strings. #1054
  • Add documentation for adding teaser images in grid view using header.teaser.

4.4.1

Enhancements

  • Add Greek localized UI text strings. #958

Bug Fixes

  • Fix video helper to load Vimeo videos over https. #945
  • Fix close menu button that was removed when updating Greedy navigation script. #969

4.4.0

Enhancements

  • Move SCSS partials to /_sass/minimal-mistakes for easier CSS customization.
  • Replace modified with last_modified_at to leverage various Jekyll plugins that utilize this variable. #930
  • Add Lithuanian localized UI text. #924
  • Improve print stylesheet by increasing text contrast, removing elements that don't need to be printed, expanding URLs, and reducing amount of blank pages. #909

Maintenance

  • Remove extra word in comment. #911
  • Fix typo in Utility Class docs. #915

4.3.1

Bug Fixes

  • Fix .masthead and .page__footer overlapping full screen video elements. #933
  • Correctly show Related Posts heading when UI Text data file is omitted and related: true in YAML Front Matter. #901

4.3.0

Enhancements

  • Add workaround to allow theme gem's /assets/js/main.min.js file to be overridden by a local version. Simply add the following YAML Front Matter to the file:

    ---
    layout: 
    ---
    

    Any local customizations you make to /assets/js/main.min.js should now replace the theme gem's version.

4.2.2

Enhancements

  • Update Greedy Navigation to flexbox version to make it more flexible when dealing with long site titles (site.title). #836
  • Adjust box-shadow in navigation and author sidebar. #576
  • Add Russian, Korean, and zh-TW localized UI text. #815 #834 #838

Bug Fixes

  • Fix Discourse embedded comments bug. #823
  • Fix seo_author default value in seo.html and add author meta. #858

Maintenance

  • Add theme meta info to _layouts/default.html and main.css.
  • Update README.
  • Improve the pagination and taxonomy archive documentation. #826
  • Add comments to /docs/_config.yml to clarify use of YAML references. #847

4.2.1

Enhancements

  • Improve paginator.html to support paginated pages that live inside of a subfolder. See documentation for more details. #764

Maintenance

  • Add https protocol to Google Universal Analytics embed. #772

4.2.0

Enhancements

  • Add video helper (for YouTube/Vimeo) and video headers to single, archive, and splash layouts. #788
  • Add missing simplified Chinese localized UI text strings. #747
  • Add Nepali (Nepalese) localized UI text strings. #785
  • Remove borders from table elements found in Google Custom Search Engine widget. #759

Bug Fixes

  • Remove position: sticky JavaScript polyfill and fallback to default positioning for browsers that don't support it. #752

Maintenance

  • Fix invalid Google Universal Analytics example in documentation. #783
  • Bump jekyll-sitemap gem dependency to (1.0).

4.1.1

Enhancements

  • Remove hardcoded words_per_minute "less than" and "minute read" values and make dynamic. #703
  • Update Font Awesome to v4.7.0. #723, #722
  • Add support for YouTube channel URLs in author profile. #716

Bug Fixes

  • Add Jekyll as spec.add_runtime_dependency in .gemspec.

4.1.0

Enhancements

Bug Fixes

  • Fix link to Discourse.org homepage in noscript section #699
  • Fix padding issue with pagination buttons #694

4.0.10

Bug Fixes

  • Add Staticman default path. #683

Maintenance

  • Slight correction/improvements to French UI text. #685

4.0.9

Bug Fixes

  • Fix overlapping sidebar navigation lists due to max-height: 100vh. #668

4.0.8

Bug Fixes

  • Set default value for words_per_minute. #657
  • Adjust sidebar navigation list CSS so it collapses at the correct width.

Maintenance

  • Add Google AdSense banner to /docs/_layouts/default.html for demo site.

4.0.7

Enhancements

  • Add !default values to _sass/_variables.scss.
  • Collapse sidebar navigation lists on smaller screens. #607

Bug Fixes

  • Rename #comments to something more unique to avoid clashes with Kramdown generated headline IDs. #582

Maintenance

  • Reorganize SCSS partials in assets/css/main.scss

4.0.6

Enhancements

  • Add figure helper to make generating a <figure> element with a single image and caption easier. #572
  • Add structured data markup for itemprop="person" in author profile sidebar. #647

Bug Fixes

  • Fix improper YAML formatting of some locales. #651

Maintenance

  • Clarify "migrating to gem-theme" instructions in Quick Start Guide.
  • Add rake preview task for testing /test during theme development.

4.0.5

Enhancements

  • Update gems: jekyll-sitemap (0.12), jekyll-feed (0.8).
  • Improve next/previous pager links visibility by changing gray color to blue ($link-color).

Bug Fixes

  • Fix .sidebar flicker/jump when hovered. #583

Maintenance

  • Move contents of gh-pages branch to master inside of the /docs folder.

4.0.4

Enhancements

  • "Gemify" theme ~> gem "minimal-mistakes-jekyll"
  • Replace base_path include with absolute_url filter where possible.
  • Allow images to be placed in other folders. Remove /images/ only restriction and encourage placement in /assets/images/ instead. Full paths are now required. If upgrading from MM 3.4 add /images/ before filenames in Front Matter and _config.yml variables.
  • Add home layout
  • Added missing Turkish translations for UI text. #621
  • Make author avatar optional in sidebar.
  • Update /_includes/seo.html for meta description. #558

Bug Fixes

  • Fix navigation bar animation "flicker" in Safari #568
  • Fix author.avatar paths for externally hosted images.

Maintenance

  • Add documentation around gem "minimal-mistakes-jekyll" installation and use.
  • Add note about using full image paths for eg. assets/images/filename.jpg (header images, overlays, galleries, feature rows, etc.) instead of assuming they will always be in /images/.
  • Add "Overriding Theme Defaults" page to documentation.

3.4.8

Enhancements

  • Improve type readability for larger viewports by bumping up base font-size. #533
  • Update Portuguese localized UI text. #541
  • Add page.title and via parameter to Twitter share link. #538

Bug Fixes

  • Fix Last.fm author profile URL. #540

Maintenance

  • Move Brazilian Portuguese localized text under pt-BR key.

3.4.7

Enhancements

  • Add layout based and user-defined class names to <body> element for added CSS hooks. #526
  • Add simplified Chinese localized UI text. #532

Bug Fixes

  • Remove duplicate include of base_path in category-list.html #522

3.4.6

Enhancements

  • Add Italian "comments" related localized UI text. #514

Bug Fixes

  • Disable compress HTML layout by default. To enable add layout: compress to _layouts/default.html.

3.4.5

Enhancements

  • Improve line numbered code block styling when using {% highlight linenos %} tag. #513
  • Add English fallback to "Follow" button label. #496

Bug Fixes

  • Fix Firefox alignment issues with code blocks generated with the {% highlight %} tag. #512

Maintenance

  • Clarified comment for author.stackoverflow value used in author sidebar links. #487
  • Add list of localized text strings. #488
  • Add {% highlight %} code block examples to demo site.
  • Add documentation for using custom sidebar navigation menus. #476

3.4.4

Enhancements

  • Add French "comments" related localized UI text. #472

Bug Fixes

  • Exclude vendor in Jekyll config file.
  • Fix Liquid syntax error for offending parenthesis. #479

Maintenance

  • Update gems: colorator (1.1.0), forwardable-extended (2.6.0), github-pages (93), jekyll (= 3.2.1), minima (= 1.0.1).

3.4.3

Enhancements

  • Make "honeypot" input in Staticman comment form less obvious to spam bots
  • Add padding to .highlight code blocks to better align overflow scrollbar to the bottom.
  • Add additional image options for Twitter card social sharing meta tags. #466
  • Add structured data markup for Staticman comments. #458

Bug Fixes

  • Format og:locale tag with _ instead of -. #462

Maintenance

  • Add note to docs about using url: http://localhost:4000 when working locally.

3.4.2

Enhancements

  • Improve UX of static comment forms. #448

3.4.1

Enhancements

  • Add staticman.filename configuration with UNIX timestamp for sorting data files. example ~> comment-1470943149.

Bug Fixes

  • Don't add <a> to author name if URL is blank.

3.4.0

Enhancements

  • Support static-based commenting via Staticman for sites hosted with GitHub Pages. #424

3.3.7

Bug Fixes

  • Re-enabled Jekyll plugins in _config.yml in case they aren't autoloaded in Gemfile. #417

Enhancements

Maintenance

3.3.6

Bug Fixes

  • Fix blank site.teaser bug. #412

3.3.5

Enhancements

  • Add English default text site.locale strings. #407
  • Add Portuguese localized UI text. #411
  • Add Italian localized UI text. #409

Maintenance

  • Remove unused Google AdSense variables in _config.yml. #404
  • Update Gemfile instructions for using github-pages vs. native jekyll gems.
  • Disable gems: in _config.yml and enable plugins with Bundler instead.
  • Add repository to _config.yml to suppress GitHub Pages error Liquid Exception: No repo name found.

3.3.4

Enhancements

  • Add support for configurable feed URL to use a service like FeedBurner instead of linking directly to feed.xml in <head> and the site footer. #378, #379, #406
  • Add Turkish localized UI text. #403

Maintenance

  • Update gems: activesupport (4.2.7), ffi (1.9.14), github-pages (88), jekyll-redirect-from (0.11.0), jekyll-watch (1.5.0).

3.3.3

Enhancements

  • Make footer stick to the bottom of the page.

Bug Fixes

  • Fix gallery size bug #402

Maintenance

  • Set default lang to en.

3.3.2

Bug Fixes

  • Fix JavaScript that triggers "sticky" sidebar to avoid layout issues on screen sizes < 1024px. #396

3.3.1

Enhancements

  • Enable image popup on < 500px wide screens. #385
  • Indicate the relationship between component URLs in a paginated series by applying rel="prev" and rel="next" to pages that use site.paginator. #253
  • Improve link posts in archive listings. #276

Maintenance

  • Update gems: github-pages (86), ffi 1.9.13, jekyll-mentions 1.1.3, and rouge 1.11.1
  • Fix note about custom sidebar content appearing below author profile. #388

3.2.13

Enhancements

  • Add English default UI text for Canada, Great Britain, and Australia. #377
  • Switch default locale from en-US to en.

3.2.12

Enhancements

  • Remove window width "magic number" from sticky sidebar check in main.js for improved flexibility. #375

Bug Fixes

  • Fix author override conditional where a missing authors.yml would show broken sidebar content. Defaults to site.author. #376

3.2.11

Bug Fixes

  • Fix disappearing author sidebar links #372

Maintenance

  • Update gems: github-pages (84), jekyll-github-metadata 2.0.2, and kramdown 1.11.1
  • Update vendor JavaScript: jQuery 1.12.4, Stickyfill.js 1.1.4
  • Update Font Awesome 4.6.3

3.2.10

Maintenance

  • Add CONTRIBUTING.md

3.2.9

Enhancements

Bug Fixes

  • Fix Person typo Schema.org type #358

Maintenance

  • Update github-pages gem and dependencies.
  • Remove minutes_read to avoid awkward reading time wording #356

3.2.8

Bug Fixes

  • Remove cursor: pointer that appears on white-space surrounding author side list items and links. #354

Maintenance

  • Add contributing information to README.md. #357

3.2.7

Enhancements

  • Add French localized UI text. #346

Bug Fixes

  • Fix branch logic for Yandex and Alexa in seo.html. #348

3.2.6

Bug Fixes

  • Fix error Liquid Exception: divided by 0 in _includes/archive-single.html, included in _layouts/single.html caused by null words_per_minute in _config.yml. #345

3.2.5

Bug Fixes

  • Fix link color in hero overlay to be white.
  • Remove underlines from archive item titles.

3.2.4

Enhancements

  • Improve text alignment of masthead, hero overlay, page footer to be flush left and remove awkward white-space gaps. #342
  • Add Spanish localized UI text. #338

Bug Fixes

  • Fix alignment of icons in author sidebar #341

Maintenance

  • Add background color to page footer to set it apart from main content. #342
  • Add terms and privacy policy to theme's demo site. #343
  • Update screenshots found in theme documentation.

3.2.3

Enhancements

3.2.2

Enhancements

  • Add support for image captions in Magnific Popup overlays via the gallery helper. #334

3.2.1

Bug Fixes

  • Remove need for "double tapping" masthead menu links on iOS devices. #315

Maintenance

  • Add ISSUE_TEMPLATE.md for improve issue submission process.

3.2.0

Bug Fixes

  • Fix missing category/tag links in post footer due to possible conflict with site.tags and site.categories. #329

3.1.8

Bug Fixes

  • Fix Liquid Exception: undefined method 'gsub' for nil:NilClass in _layouts/single.html error when page.title is null. <h1> element is now conditional if title: is not set for a page or collection item. #312

Maintenance

  • Remove duplicate fa-twitter and fa-twitter-square classes from _utilities.scss. #302

  • Document installing additional Jekyll gem dependencies when using gem "jekyll" instead of gem "github-pages" to avoid any errors on run. #305

3.1.7

Enhancements

  • Add translation key for "Recent Posts" used in home page index.html. #316

Maintenance

  • Small fix to avoid underlying the whitespace between icons and related text when hovering. #303

3.1.6

Maintenance

  • Update gem dependencies. Run bundle to update Gemfile.lock.

3.1.5

Maintenance

  • Fix www and https links in author profile include #293

3.1.4

Enhancements

  • Add overlay_filter param to hero headers #298

3.1.3

Enhancements

  • Improve site.locale documentation #284
  • Remove ProTip note about protocol-less site.url as it is an anti-pattern #288

Bug Fixes

  • Fix og_image URL in seo.html #277
  • Fix author_profile toggle when assigned in a _layout #285
  • Fix typo in build:all npm script #283
  • Fix URL typo documentation #287
  • SEO author bug. If twitter.username is set and author.twitter is nil bad things happen. #289

3.1.2

Enhancements

  • Explain how to use nav_list helper in documentation.
  • Reduce left/right padding on smaller screens to increase width of main content column.

Bug Fixes

  • Fix alignment issues with related posts #273 and "Follow" button in author profile #274.

3.1.1

Bug Fix

  • Fixed reading time bug when words_per_minute wasn't set in _config.yml #271

3.1.0

Enhancements

  • Updated Font Awesome to version 4.6.1
  • Added optional GitHub and Bitbucket links to footer if set on site.author in _config.yml.

Bug Fixes

  • Fixed Bitbucket URL typo in author sidebar.

3.0.3

Enhancements

  • Rebuilt the entire theme: layouts, includes, stylesheets, scripts, you name it.
  • Refreshed the look and feel while staying true to the original design of the theme (author sidebar/main content).
  • Replaced grid system with Susy.
  • Replaced Grunt tasks with npm scripts.
  • Removed Google Fonts and replaced with system fonts to improve performance (they can be added back if desired)
  • Greatly improved theme documentation.
  • Increased the amount of sample posts, sample pages, and sample collections to throughly test the theme and edge-cases.
  • Moved all sample content and assets out of master to keep it as clean as possible for forking.
  • Added new layouts for splash pages, archives for jekyll-archives if enabled, and compress.html to improve performance.
  • Added taxonomy links to posts (tags and categories).
  • Added optional "reading time" meta data.
  • Improved Liquid used for Twitter Cards and Open Graph data in <head>.
  • Improved gallery include helper and added feature_row for use with splash page layout.
  • Added Keybase.io, author web URI, and Bitbucket optional links to sidebar.
  • Add feed.xml link to footer.
  • Added a UI text data file to easily change all text found in the theme.
  • Added LinkedIn to optional social share buttons.
  • Added Facebook, Google+, and custom commenting options in addition to Disqus.
  • Added optional breadcrumb links.

2.2.1

2.2.0

Enhancements

  • Add support for Jekyll 3.0
  • Minor updates to syntax highlighting CSS and theme documentation

2.1.3

Enhancements

  • Cleaner print styles that remove the top navigation, social sharing buttons, and other elements not needed when printed.

2.1.2

Enhancements

  • Add optional CodePen icon/url to author side bar #156
  • Documented Stackoverflow username explanation in _config.yml #157
  • Simplified Liquid in post-index.html to better handle year listings #166

Bug Fixes

  • Cleanup Facebook related Open Graph meta tags #149
  • Corrected minor typos #158 #175

2.1.1

Enhancements

  • Add optional XING profile link to author sidebar
  • Include open graph meta tags for feature image (if assigned) #149
  • Create an include for feed footer

Bug Fixes

  • Remove http protocol from Google search form on sample 404 page
  • Only show related posts if there are one or more available
  • Fix alignment of email address link in author sidebar

2.1.0

Enhancements

  • Add optional social sharing buttons (#42)

social sharing buttons

  • Add Soundcloud, YouTube (#95), Flickr (#119), and Weibo (#116) icons for use in author sidebar.
  • Fix typos in posts and documentation and remove references to Less
  • Include note about Octopress gem being optional
  • Post author override support extended to the Atom feed (#71)
  • Only include email address in feed if specified in _config.yml or author _data
  • Wrap all page content in #main to harmonize article and post index styles (#86)
  • Include new sample feature images for posts and pages
  • Table of contents improvements: fix collapse toggle, indent nested elements, show on small screens, and create an _include for reusing in posts and pages.
  • Include note about running Jekyll with bundle exec when using Bundler
  • Fix home page path in top navigation
  • Remove Google Authorship (#120)
  • Remove duplicate author content that displayed in div.article-author-bottom
  • Removed unused _sass/print.scss styles
  • Improve comments in .scss files

2.0.0

1.3.3

Enhancements

  • Added new icons and profile links for Stackoverflow, Dribbble, Pinterest, Foursquare, and Steam to the author bio sidebar.
  • Cleaned up the Kramdown auto table of contents styling to be more readable
  • Removed page width specific .less stylesheets and created mixins for easier updating
  • Removed Modernizr since it wasn't being used
  • Added pages to sitemap.xml
  • Added category: to rake new_post task
  • Minor typographic changes

Bug Fixes

  • Corrected various broken links in README and Theme Setup.

1.3.1

Enhancements

  • Cleaned up table of contents styling
  • Reworked top navigation to be a better experience on small screens. Nav items now display vertically when the menu button is tapped, revealing links with larger touch targets.

menu animation

1.2.0

Bug Fixes

  • Table weren't filling the entire width of the content container. They now scale at 100%. Thanks @dhruvbhatia

Enhancements

  • Decreased spacing between Markdown footnotes
  • Removed dark background on footer
  • Removed UPPERCASE styling on post titles in the index listing

1.1.4

Bug Fixes

  • Fix top navigation bug issue (#10) for real this time. Remember to clear your floats kids.

1.1.3

Bug Fixes

  • Fix top navigation links that weren't click able on small viewports (Issue #10).
  • Remove line wrap from top navigation links that may span multiple lines.

1.1.2

Enhancements

  • Added Grunt build script for compiling Less/JavaScript and optimizing image assets.
  • Added support for large image summary Twitter card.
  • Stylesheet adjustments

1.1.1

Bug Fixes

Enhancements

  • Added image attribution for post and page feature images.
  • Added 404 page.
  • Cleaned up various Less variables to better align with naming conventions used in other MM Jekyll themes.
  • Removed Chrome Frame references.
  • Added global CSS3 transitions to text and block elements.
  • Improved typography in a few places.

1.0.2

Enhancements

  • Google Analytics, Google Authorship, webmaster verifies, and Twitter card meta are now optional.

1.0.1