diff --git a/.gitignore b/.gitignore index 21206165..5c4866d7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,14 @@ +*.gem *.sublime-project *.sublime-workspace +.bundle .DS_Store .jekyll-metadata .sass-cache _asset_bundler_cache _site codekit-config.json +example/_site +Gemfile.lock node_modules npm-debug.log* \ No newline at end of file diff --git a/Gemfile b/Gemfile index 6c08bcf0..12914989 100644 --- a/Gemfile +++ b/Gemfile @@ -1,24 +1,2 @@ source "https://rubygems.org" - -# Hello! This is where you manage which Jekyll version is used to run. -# When you want to use a different version, change it below, save the -# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: -# -# bundle exec jekyll serve -# -# This will help ensure the proper Jekyll version is running. -# Happy Jekylling! - -gem "github-pages", group: :jekyll_plugins - -# If you want to use Jekyll native, uncomment the line below. -# To upgrade, run `bundle update`. - -# gem "jekyll" - -gem "wdm", "~> 0.1.0" if Gem.win_platform? - -# If you have any plugins, put them here! -group :jekyll_plugins do - # gem "jekyll-archives" -end \ No newline at end of file +gemspec \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index f155ec95..00000000 --- a/Gemfile.lock +++ /dev/null @@ -1,146 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (4.2.7) - i18n (~> 0.7) - json (~> 1.7, >= 1.7.7) - minitest (~> 5.1) - thread_safe (~> 0.3, >= 0.3.4) - tzinfo (~> 1.1) - addressable (2.4.0) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.10.0) - colorator (1.1.0) - ethon (0.9.0) - ffi (>= 1.3.0) - execjs (2.7.0) - faraday (0.9.2) - multipart-post (>= 1.2, < 3) - ffi (1.9.14) - ffi (1.9.14-x64-mingw32) - forwardable-extended (2.6.0) - gemoji (2.1.0) - github-pages (96) - activesupport (= 4.2.7) - github-pages-health-check (= 1.2.0) - jekyll (= 3.2.1) - jekyll-coffeescript (= 1.0.1) - jekyll-feed (= 0.5.1) - jekyll-gist (= 1.4.0) - jekyll-github-metadata (= 2.0.2) - jekyll-mentions (= 1.2.0) - jekyll-paginate (= 1.1.0) - jekyll-redirect-from (= 0.11.0) - jekyll-sass-converter (= 1.3.0) - jekyll-seo-tag (= 2.0.0) - jekyll-sitemap (= 0.10.0) - jemoji (= 0.7.0) - kramdown (= 1.11.1) - liquid (= 3.0.6) - listen (= 3.0.6) - mercenary (~> 0.3) - minima (= 1.2.0) - rouge (= 1.11.1) - terminal-table (~> 1.4) - github-pages-health-check (1.2.0) - addressable (~> 2.3) - net-dns (~> 0.8) - octokit (~> 4.0) - public_suffix (~> 1.4) - typhoeus (~> 0.7) - html-pipeline (2.4.2) - activesupport (>= 2) - nokogiri (>= 1.4) - i18n (0.7.0) - jekyll (3.2.1) - colorator (~> 1.0) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 1.1) - kramdown (~> 1.3) - liquid (~> 3.0) - mercenary (~> 0.3.3) - pathutil (~> 0.9) - rouge (~> 1.7) - safe_yaml (~> 1.0) - jekyll-coffeescript (1.0.1) - coffee-script (~> 2.2) - jekyll-feed (0.5.1) - jekyll-gist (1.4.0) - octokit (~> 4.2) - jekyll-github-metadata (2.0.2) - jekyll (~> 3.1) - octokit (~> 4.0) - jekyll-mentions (1.2.0) - activesupport (~> 4.0) - html-pipeline (~> 2.3) - jekyll (~> 3.0) - jekyll-paginate (1.1.0) - jekyll-redirect-from (0.11.0) - jekyll (>= 2.0) - jekyll-sass-converter (1.3.0) - sass (~> 3.2) - jekyll-seo-tag (2.0.0) - jekyll (~> 3.1) - jekyll-sitemap (0.10.0) - jekyll-watch (1.5.0) - listen (~> 3.0, < 3.1) - jemoji (0.7.0) - activesupport (~> 4.0) - gemoji (~> 2.0) - html-pipeline (~> 2.2) - jekyll (>= 3.0) - json (1.8.3) - kramdown (1.11.1) - liquid (3.0.6) - listen (3.0.6) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9.7) - mercenary (0.3.6) - mini_portile2 (2.1.0) - minima (1.2.0) - minitest (5.9.0) - multipart-post (2.0.0) - net-dns (0.8.0) - nokogiri (1.6.8) - mini_portile2 (~> 2.1.0) - pkg-config (~> 1.1.7) - nokogiri (1.6.8-x64-mingw32) - mini_portile2 (~> 2.1.0) - pkg-config (~> 1.1.7) - octokit (4.3.0) - sawyer (~> 0.7.0, >= 0.5.3) - pathutil (0.14.0) - forwardable-extended (~> 2.6) - pkg-config (1.1.7) - public_suffix (1.5.3) - rb-fsevent (0.9.7) - rb-inotify (0.9.7) - ffi (>= 0.5.0) - rouge (1.11.1) - safe_yaml (1.0.4) - sass (3.4.22) - sawyer (0.7.0) - addressable (>= 2.3.5, < 2.5) - faraday (~> 0.8, < 0.10) - terminal-table (1.7.2) - unicode-display_width (~> 1.1.1) - thread_safe (0.3.5) - typhoeus (0.8.0) - ethon (>= 0.8.0) - tzinfo (1.2.2) - thread_safe (~> 0.1) - unicode-display_width (1.1.1) - wdm (0.1.1) - -PLATFORMS - ruby - x64-mingw32 - -DEPENDENCIES - github-pages - wdm (~> 0.1.0) - -BUNDLED WITH - 1.12.5 diff --git a/LICENSE b/LICENSE.txt similarity index 100% rename from LICENSE rename to LICENSE.txt diff --git a/README.md b/README.md index c344fefe..2b832306 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/) -[![GitHub release](https://img.shields.io/github/release/mmistakes/minimal-mistakes.svg)](https://github.com/mmistakes/minimal-mistakes/releases) [![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE) +[![GitHub release](https://img.shields.io/gem/v/minimal-mistakes-jekyll.svg)](https://github.com/mmistakes/minimal-mistakes/releases) [![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE) Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your personal site, blog, or portfolio on GitHub or self-hosting on your own server. As the name implies --- styling is purposely minimalistic to be enhanced and customized by you :smile:. @@ -11,26 +11,22 @@ Interested in testing out a [**pre-release "gemified" version**](https://github. [![Minimal Mistakes live preview][2]][1] [1]: https://mmistakes.github.io/minimal-mistakes/ -[2]: images/mm-browser-mockups.png (live preview) +[2]: screenshot.png (live preview) -The theme includes responsive layouts (`single`, `archive`, and `splash` pages) that look great on mobile and desktop browsers. +![layout examples](screenshot-layouts.png) -![layout examples](images/mm-layout-examples.png) - -## [Installation and Setup](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/) / [Preview the Theme](https://mmistakes.github.io/minimal-mistakes/) - -### Notable Features +## Notable Features - Compatible with Jekyll 3.x and GitHub Pages - Support for Jekyll's built-in Sass/SCSS preprocessor -- Several layout options (single, archive, splash pages) +- Several responsive layout options (single, archive index, splash, and paginated home page) - SEO optimized with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data -- Optional header images, sidebars, table of contents, galleries, related posts, breadcrumb links, and more. -- Optional comments ([Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman](https://staticman.net/), and custom). -- Optional analytics ([Google Analytics](https://www.google.com/analytics/) and custom). -- UI localized text: English (default), Spanish, French, and Turkish. +- Optional [header images](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#headers), [custom sidebars](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#sidebars), [table of contents](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#table-of-contents), [galleries](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#gallery), related posts, [breadcrumb links](https://mmistakes.github.io/minimal-mistakes/docs/configuration/#breadcrumb-navigation-beta), [navigation lists](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#navigation-list), and more. +- Commenting support (powered by [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman](https://staticman.net/), and custom). +- [Google Analytics](https://www.google.com/analytics/) support. +- UI localized text in English (default), Brazilian Portguese, Chinese, French, German, Italian, Spanish, and Turkish -#### Demo Pages +## Demo Pages | Name | Description | | ------------------------------------------- | ----------------------------------------------------- | @@ -42,7 +38,7 @@ The theme includes responsive layouts (`single`, `archive`, and `splash` pages) | [Categories Archive][categories-archive] | Posts grouped by category. | | [Tags Archive][tags-archive] | Posts grouped by tags. | -For even more demo pages check the [posts archive][year-archive]. +For even more demo pages check the [posts archive][year-archive] on the demo site. Looking for the source code to peep the YAML Front Matter and Markdown used? Check the [`gh-pages`](https://github.com/mmistakes/minimal-mistakes/tree/gh-pages) branch. [header-image-post]: https://mmistakes.github.io/minimal-mistakes/layout-header-image-text-readability/ [gallery-post]: https://mmistakes.github.io/minimal-mistakes/post%20formats/post-gallery/ @@ -53,6 +49,32 @@ For even more demo pages check the [posts archive][year-archive]. [tags-archive]: https://mmistakes.github.io/minimal-mistakes/tags/ [year-archive]: https://mmistakes.github.io/minimal-mistakes/year-archive/ +## Quick Start + +Add this line to your Jekyll site's `Gemfile`: + +```ruby +gem "minimal-mistakes-jekyll" +``` + +Add this line to your Jekyll site's `_config.yml` file: + +```yaml +theme: minimal-mistakes-jekyll +``` + +Run Bundler: + +```bash +bundle install +``` + +## Usage + +For detailed instructions on how to configure, customize, add content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/). + +**Note:** Gem version of the theme requires Jekyll v3.3+ and is not supported with sites hosted with [GitHub Pages](https://pages.github.com/). You can still use the theme on GitHub Pages, you'll just need to install using the old "[repo fork method](https://mmistakes.github.io/minimal-mistakes/docs/installation/)". + --- ## Contributing @@ -67,6 +89,8 @@ This goes for author sidebar links and "share button" additions -- I have no int To help me out try to avoid creating pull requests on `master` and instead branch off of `develop`. It's much easier for me to test, merge, and roll them into new releases this way. +Theme documentation and demo pages can be found in the `gh-pages` branch, please submit pull requests against that branch. + --- ## Credits diff --git a/_config.yml b/_config.yml index 78c1c6d2..51bb6cab 100644 --- a/_config.yml +++ b/_config.yml @@ -14,7 +14,7 @@ description : "An amazing website." url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" baseurl : # the subpath of your site, e.g. "/blog" repository : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes" -teaser : # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png" +teaser : # path of fallback teaser image, e.g. "/assets/images/500x300.png" # breadcrumbs : false # true, false (default) words_per_minute : 200 comments: @@ -78,7 +78,7 @@ analytics: # Site Author author: name : "Your Name" - avatar : "bio-photo.jpg" + avatar : # path of avatar image, e.g. "/assets/images/bio-photo.jpg" bio : "I am an amazing person." location : "Somewhere" email : @@ -226,4 +226,19 @@ tag_archive: compress_html: clippings: all ignore: - envs: development \ No newline at end of file + envs: development + + +# Defaults +defaults: + # _posts + - scope: + path: "" + type: posts + values: + layout: single + author_profile: true + read_time: true + comments: # true + share: true + related: true \ No newline at end of file diff --git a/_data/navigation.yml b/_data/navigation.yml index ebc12e81..e61d43bd 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -1,7 +1,12 @@ # main links links main: - - title: "Sample Navigation Link" - url: https://mmistakes.github.io/minimal-mistakes/docs/navigation/ - - - title: "Sample Navigation Link 2" - url: / \ No newline at end of file + - title: "Quick-Start Guide" + url: https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/ + - title: "About" + url: https://mmistakes.github.io/minimal-mistakes/about/ + - title: "Sample Posts" + url: /year-archive/ + - title: "Sample Collections" + url: /collection-archive/ + - title: "Sitemap" + url: /sitemap/ \ No newline at end of file diff --git a/_includes/archive-single.html b/_includes/archive-single.html index e904447f..93755e38 100644 --- a/_includes/archive-single.html +++ b/_includes/archive-single.html @@ -1,5 +1,3 @@ -{% include base_path %} - {% if post.header.teaser %} {% capture teaser %}{{ post.header.teaser }}{% endcapture %} {% else %} @@ -20,16 +18,16 @@ {% if teaser contains "://" %} "{{ teaser }}" {% else %} - "{{ teaser | prepend: "/images/" | prepend: base_path }}" + "{{ teaser | absolute_url }}" {% endif %} alt=""> {% endif %}

{% if post.link %} - {{ title }} Permalink + {{ title }} Permalink {% else %} - {{ title }} + {{ title }} {% endif %}

{% if post.read_time %} diff --git a/_includes/author-profile.html b/_includes/author-profile.html index 510a1ba9..97261f32 100644 --- a/_includes/author-profile.html +++ b/_includes/author-profile.html @@ -1,18 +1,18 @@ -{% include base_path %} - {% if page.author and site.data.authors[page.author] %} {% assign author = site.data.authors[page.author] %}{% else %}{% assign author = site.author %} {% endif %}
-
- {% if author.avatar contains "://" %} - {{ author.name }} - {% else %} - {{ author.name }} - {% endif %} -
+ {% if author.avatar %} +
+ {% if author.avatar contains "://" %} + {{ author.name }} + {% else %} + {{ author.name }} + {% endif %} +
+ {% endif %}

{{ author.name }}

diff --git a/_includes/breadcrumbs.html b/_includes/breadcrumbs.html index 2b9f7a9e..cf2b745e 100644 --- a/_includes/breadcrumbs.html +++ b/_includes/breadcrumbs.html @@ -1,5 +1,3 @@ -{% include base_path %} - {% case site.categories.type %} {% when "liquid" %} {% assign path_type = "#" %} @@ -21,7 +19,7 @@ {% for crumb in crumbs offset: 1 %} {% if forloop.first %}
  • - {{ site.data.ui-text[site.locale].breadcrumb_home_label | default: "Home" }} + {{ site.data.ui-text[site.locale].breadcrumb_home_label | default: "Home" }}
    • {{ site.data.ui-text[site.locale].breadcrumb_separator | default: "/" }} @@ -31,7 +29,7 @@ {% else %} {% assign i = i | plus: 1 %}
  • - {{ crumb | replace: '-', ' ' | replace: '%20', ' ' | capitalize }} + {{ crumb | replace: '-', ' ' | replace: '%20', ' ' | capitalize }}
    • {{ site.data.ui-text[site.locale].breadcrumb_separator | default: "/" }} diff --git a/_includes/category-list.html b/_includes/category-list.html index 4c274270..039d5e2e 100644 --- a/_includes/category-list.html +++ b/_includes/category-list.html @@ -1,5 +1,3 @@ -{% include base_path %} - {% case site.category_archive.type %} {% when "liquid" %} {% assign path_type = "#" %} @@ -21,7 +19,7 @@ {% for hash in category_hashes %} {% assign keyValue = hash | split: '#' %} {% capture category_word %}{{ keyValue[1] | strip_newlines }}{% endcapture %} - {% unless forloop.last %}, {% endunless %} + {% unless forloop.last %}, {% endunless %} {% endfor %}

    diff --git a/_includes/comments.html b/_includes/comments.html index 39b4983b..e1459973 100644 --- a/_includes/comments.html +++ b/_includes/comments.html @@ -1,5 +1,3 @@ -{% include base_path %} -
    {% capture comments_label %}{{ site.data.ui-text[site.locale].comments_label | default: "Comments" }}{% endcapture %} {% case site.comments.provider %} @@ -8,10 +6,10 @@
    {% when "facebook" %}

    {{ comments_label }}

    -
    +
    {% when "google-plus" %}

    {{ comments_label }}

    -
    Loading Google+ Comments ...
    +
    Loading Google+ Comments ...
    {% when "staticman" %}
    {% if site.repository and site.staticman.branch %} diff --git a/_includes/feature_row b/_includes/feature_row index b84f36b2..d5b7e23d 100644 --- a/_includes/feature_row +++ b/_includes/feature_row @@ -1,5 +1,3 @@ -{% include base_path %} - {% if include.id %} {% assign feature_row = page.[include.id] %} {% else %} @@ -13,7 +11,7 @@ {% if f.url contains "://" %} {% capture f_url %}{{ f.url }}{% endcapture %} {% else %} - {% capture f_url %}{{ f.url | prepend: base_path }}{% endcapture %} + {% capture f_url %}{{ f.url | absolute_url }}{% endcapture %} {% endif %}
    @@ -24,7 +22,7 @@ {% if f.image_path contains "://" %} "{{ f.image_path }}" {% else %} - "{{ f.image_path | prepend: "/images/" | prepend: base_path }}" + "{{ f.image_path | absolute_url }}" {% endif %} alt="{% if f.alt %}{{ f.alt }}{% endif %}">
    diff --git a/_includes/footer.html b/_includes/footer.html index 53b99eb0..8fe13bbd 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,5 +1,3 @@ -{% include base_path %} -
    diff --git a/_includes/gallery b/_includes/gallery index 4d271ee9..5983239c 100644 --- a/_includes/gallery +++ b/_includes/gallery @@ -1,5 +1,3 @@ -{% include base_path %} - {% if include.id %} {% assign gallery = page.[include.id] %} {% else %} @@ -21,7 +19,7 @@ {% if img.url contains "://" %} "{{ img.url }}" {% else %} - "{{ img.url | prepend: "/images/" | prepend: base_path }}" + "{{ img.url | absolute_url }}" {% endif %} {% if img.title %}title="{{ img.title }}"{% endif %} > @@ -29,7 +27,7 @@ {% if img.image_path contains "://" %} "{{ img.image_path }}" {% else %} - "{{ img.image_path | prepend: "/images/" | prepend: base_path }}" + "{{ img.image_path | absolute_url }}" {% endif %} alt="{% if img.alt %}{{ img.alt }}{% endif %}"> @@ -38,7 +36,7 @@ {% if img.image_path contains "://" %} "{{ img.image_path }}" {% else %} - "{{ img.image_path | prepend: "/images/" | prepend: base_path }}" + "{{ img.image_path | absolute_url }}" {% endif %} alt="{% if img.alt %}{{ img.alt }}{% endif %}"> {% endif %} diff --git a/_includes/head.html b/_includes/head.html index ffcc7416..a59b14a2 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -1,10 +1,8 @@ -{% include base_path %} - {% include seo.html %} - + @@ -16,6 +14,6 @@ - + \ No newline at end of file diff --git a/_includes/masthead.html b/_includes/masthead.html index ffef5594..5e9a1d59 100644 --- a/_includes/masthead.html +++ b/_includes/masthead.html @@ -1,17 +1,15 @@ -{% include base_path %} -