Skip to content

Commit

Permalink
Merge branch 'mmistakes:master' into update
Browse files Browse the repository at this point in the history
  • Loading branch information
thetjswo authored May 3, 2024
2 parents dbfef2c + 1b06aff commit de3cc61
Show file tree
Hide file tree
Showing 48 changed files with 1,843 additions and 1,428 deletions.
2 changes: 0 additions & 2 deletions .github/FUNDING.yml

This file was deleted.

5 changes: 5 additions & 0 deletions .github/workflows/bad-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ on:
pull_request_target:
types: [opened, reopened]

permissions:
contents: read

jobs:
close-pr:
permissions:
pull-requests: write
runs-on: ubuntu-latest
if: "contains(github.event.pull_request.body, 'by deleting this comment block') || github.event.pull_request.body == ''"
steps:
Expand Down
544 changes: 292 additions & 252 deletions CHANGELOG.md

Large diffs are not rendered by default.

44 changes: 26 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,11 @@

[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE)
[![Jekyll](https://img.shields.io/badge/jekyll-%3E%3D%203.7-blue.svg)](https://jekyllrb.com/)
[![Ruby gem](https://img.shields.io/gem/v/minimal-mistakes-jekyll.svg)](https://rubygems.org/gems/minimal-mistakes-jekyll)
[![Tip Me via PayPal](https://img.shields.io/badge/PayPal-tip%20me-green.svg?logo=paypal)](https://www.paypal.me/mmistakes)
[![Donate to this project using Buy Me A Coffee](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg)](https://www.buymeacoffee.com/mmistakes)

Minimal Mistakes is a flexible two-column Jekyll theme, perfect for building personal sites, blogs, and portfolios. As the name implies, styling is purposely minimalistic to be enhanced and customized by you :smile:.

:sparkles: See what's new in the [CHANGELOG](CHANGELOG.md).

**If you enjoy this theme, please consider sponsoring:**

[!["Buy Me A Coffee"](https://user-images.githubusercontent.com/1376749/120938564-50c59780-c6e1-11eb-814f-22a0399623c5.png)](https://www.buymeacoffee.com/mmistakes)
[![Support via PayPal](https://cdn.jsdelivr.net/gh/twolfson/[email protected]/dist/button.svg)](https://www.paypal.me/mmistakes)

**Note:** The theme uses the [jekyll-include-cache](https://github.com/benbalter/jekyll-include-cache) plugin which will need to be installed in your `Gemfile` and must be retained in the `plugins` array of `_config.yml`. Otherwise you'll encounter `Unknown tag 'include_cached'` errors at build.

[![Minimal Mistakes live preview][2]][1]
Expand All @@ -35,7 +27,7 @@ Minimal Mistakes is a flexible two-column Jekyll theme, perfect for building per
- 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/), [utterances](https://utteranc.es/), and [giscus](https://giscus.app/)).
- [Google Analytics](https://www.google.com/analytics/) support.
- UI localized text in English (default), Arabic (عربي), Brazilian Portuguese (Português brasileiro), Catalan, Chinese, Danish, Dutch, Finnish, French (Français), German (Deutsch), Greek, Hebrew, Hindi (हिंदी), Hungarian, Indonesian, Irish (Gaeilge), Italian (Italiano), Japanese, Kiswahili, Korean, Malayalam, Myanmar (Burmese), Nepali (Nepalese), Norwegian (Norsk), Persian (فارسی), Polish, Punjabi (ਪੰਜਾਬੀ), Romanian, Russian, Slovak, Spanish (Español), Swedish, Thai, Turkish (Türkçe), and Vietnamese.
- UI localized text in English (default), Arabic (عربي), Brazilian Portuguese (Português brasileiro), Catalan, Chinese, Danish, Dutch, Finnish, French (Français), German (Deutsch), Greek, Hebrew, Hindi (हिंदी), Hungarian, Indonesian, Irish (Gaeilge), Italian (Italiano), Japanese, Kiswahili, Korean, Malayalam, Myanmar (Burmese), Nepali (Nepalese), Norwegian (Norsk), Persian (فارسی), Polish, Punjabi (ਪੰਜਾਬੀ), Romanian, Russian, Slovak, Spanish (Español), Swedish, Thai, Turkish (Türkçe), Ukrainian (Українська) and Vietnamese.

## Skins (color variations)

Expand Down Expand Up @@ -123,22 +115,42 @@ To install:

2. Add `jekyll-include-cache` to the `plugins` array of your `_config.yml`.

3. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command:
3. Fetch and update bundled gems by running the following [Bundler](https://bundler.io/) command:

```bash
bundle
```

4. Add `remote_theme: "mmistakes/[email protected]"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
4. Add `remote_theme: "mmistakes/[email protected]"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.

<!--
Dev note: The version number is currently hard-coded in these files:

- README.md (this file)
- package.json
- docs/_config.yml (as theme_version)
- docs/_pages/home.md (in Front Matter "excerpt")

For every release, files listed above should be manually updated with the new version number.

Additionally, the license year is hard-coded in these files:

- README.md (this file, near the end)
- LICENSE

The following files should also be regenerated:

- _includes/copyright.html, _includes/copyright.js, _sass/minimal-mistakes/_copyright.scss
(Run `bundle exec rake clean` then `bundle exec rake copyright` - all three references `package.json`)
- assets/js/main.min.js (Run `npm run build:js`, references `_includes/copyright.js`)
-->

**Looking for an example?** Use the [Minimal Mistakes remote theme starter](https://github.com/mmistakes/mm-github-pages-starter/generate) for the quickest method of getting a GitHub Pages hosted site up and running. Generate a new repository from the starter, replace sample content with your own, and configure as needed.

## Usage

For detailed instructions on how to configure, customize, add/migrate content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).

---

## Contributing

Found a typo in the documentation or interested in [fixing a bug](https://github.com/mmistakes/minimal-mistakes/issues)? Then by all means [submit an issue](https://github.com/mmistakes/minimal-mistakes/issues/new) or [pull request](https://help.github.com/articles/using-pull-requests/). If this is your first pull request, it may be helpful to read up on the [GitHub Flow](https://guides.github.com/introduction/flow/) first.
Expand All @@ -161,8 +173,6 @@ To set up your environment to develop this theme, run `bundle install`.

To test the theme, run `bundle exec rake preview` and open your browser at `http://localhost:4000/test/`. This starts a Jekyll server using content in the `test/` directory. As modifications are made to the theme and test site, it will regenerate and you should see the changes in the browser after a refresh.

---

## Credits

### Creator
Expand All @@ -175,7 +185,7 @@ To test the theme, run `bundle exec rake preview` and open your browser at `http

### Icons + Demo Images:

- [The Noun Project](https://thenounproject.com) -- Garrett Knoll, Arthur Shlain, and [tracy tam](https://thenounproject.com/tracytam)
- [The Noun Project](https://thenounproject.com) - Garrett Knoll, Arthur Shlain, and [tracy tam](https://thenounproject.com/tracytam)
- [Font Awesome](http://fontawesome.io/)
- [Unsplash](https://unsplash.com/)

Expand All @@ -193,8 +203,6 @@ To test the theme, run `bundle exec rake preview` and open your browser at `http
- [jQuery throttle / debounce](http://benalman.com/projects/jquery-throttle-debounce-plugin/)
- [Lunr](http://lunrjs.com)

---

## License

The MIT License (MIT)
Expand Down
76 changes: 76 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
require "bundler/gem_tasks"
require "jekyll"
require "json"
require "listen"
require "rake/clean"
require "time"
require "yaml"

task :default => [:copyright, :changelog]

package_json = JSON.parse(File.read("package.json"))

def listen_ignore_paths(base, options)
[
Expand Down Expand Up @@ -74,3 +82,71 @@ task :preview do

Jekyll::Commands::Serve.process(options)
end

task :changelog => "docs/_docs/18-history.md"
file "docs/_docs/18-history.md" => "CHANGELOG.md" do |t|
front_matter = {
title: "History",
classes: "wide",
permalink: "/docs/history/",
excerpt: "Change log of enhancements and bug fixes made to the theme.",
sidebar: {
nav: "docs",
},
last_modified_at: Time.now.iso8601,
toc: false,
}
# https://stackoverflow.com/a/49553523/5958455
front_matter = JSON.parse(JSON.dump(front_matter))
File.open(t.name, "w") do |f|
f.puts front_matter.to_yaml
f.puts "---"
f.puts ""
f.puts "<!--\n Sourced from CHANGELOG.md\n See Rakefile `task :changelog` for details\n-->"
f.puts ""
f.puts "{% raw %}"
changelog = File.read(t.prerequisites.first).gsub(/^# [^\n]*$/m, "").strip
f.write changelog
f.puts ""
f.puts "{% endraw %}"
end
end

COPYRIGHT_LINES = [
"Minimal Mistakes Jekyll Theme #{package_json["version"]} by Michael Rose",
"Copyright 2013-#{Time.now.year} Michael Rose - mademistakes.com | @mmistakes",
"Free for personal and commercial use under the MIT license",
"https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE",
]

COPYRIGHT_FILES = [
"_includes/copyright.html",
"_includes/copyright.js",
"_sass/minimal-mistakes/_copyright.scss",
]

def genenerate_copyright_file(filename, header, prefix, footer)
File.open(filename, "w") do |f|
f.puts header
COPYRIGHT_LINES.each do |line|
f.puts "#{prefix}#{line}"
end
f.puts footer
end
end

file "_includes/copyright.html" => "package.json" do |t|
genenerate_copyright_file(t.name, "<!--", " ", "-->")
end

file "_includes/copyright.js" => "package.json" do |t|
genenerate_copyright_file(t.name, "/*!", " * ", " */")
end

file "_sass/minimal-mistakes/_copyright.scss" => "package.json" do |t|
genenerate_copyright_file(t.name, "/*!", " * ", " */")
end

task :copyright => COPYRIGHT_FILES

CLEAN.include(*COPYRIGHT_FILES)
7 changes: 7 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ logo : "/assets/images/blog_logo.png"
masthead_title : # overrides the website title displayed in the masthead, use " " for no title
breadcrumbs : true
words_per_minute : 200
copyright : # "copyright" name, defaults to site.title
copyright_url : # "copyright" URL, defaults to site.url
comments:
provider : "disqus" # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "giscus", "custom"
disqus:
Expand All @@ -50,6 +52,11 @@ comments:
discussion_term : # "pathname" (default), "url", "title", "og:title"
reactions_enabled : # '1' for enabled (default), '0' for disabled
theme : # "light" (default), "dark", "dark_dimmed", "transparent_dark", "preferred_color_scheme"
strict : # 1 for enabled, 0 for disabled (default)
input_position : # "top", "bottom" # The comment input box will be placed above or below the comments
emit_metadata : # 1 for enabled, 0 for disabled (default) # https://github.com/giscus/giscus/blob/main/ADVANCED-USAGE.md#imetadatamessage
lang : # "en" (default)
lazy : # true, false # Loading of the comments will be deferred until the user scrolls near the comments container.
staticman:
branch : # "master"
endpoint : # "https://{your Staticman v3 API}/v3/entry/github/"
Expand Down
91 changes: 73 additions & 18 deletions _data/ui-text.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1112,8 +1112,11 @@ pl: &DEFAULT_PL
comment_success_msg : "Dziękuję za Twój komentarz! Zostanie dodany po akceptacji."
comment_error_msg : "Niestety wystąpił błąd. Proszę upewnij się, że wszystkie wymagane pola zostały wypełnione i spróbuj ponownie."
loading_label : "Trwa ładowanie strony..."
search_label_text :
search_label_text : "Wprowadź kryteria wyszukiwania..."
search_placeholder_text : "Wprowadź kryteria wyszukiwania..."
search_algolia_no_results : "Brak wyników"
results_found : "Znalezione wyniki"
back_to_top : "Wróć na górę"
pl-PL:
<<: *DEFAULT_PL

Expand Down Expand Up @@ -1697,9 +1700,9 @@ ga-IE:
# -----------------
fi: &DEFAULT_FI
skip_links : "Ohita linkit"
skip_primary_nav : "Hyppää pää navigaatioon"
skip_content : "Hyppää sisältöön"
skip_footer : "Hyppää alareunaan"
skip_primary_nav : "Siirry päävalikkoon"
skip_content : "Siirry sisältöön"
skip_footer : "Siirry alareunaan"
page : "Sivu"
pagination_previous : "Edellinen"
pagination_next : "Seuraava"
Expand All @@ -1710,39 +1713,39 @@ fi: &DEFAULT_FI
toc_label : "Tällä sivulla"
ext_link_label : "Suora linkki"
less_than : "vähemmän kuin"
minute_read : "lukuaika"
minute_read : "minuuttia luettavaa"
share_on_label : "Jaa"
meta_label :
tags_label : "Tagit:"
tags_label : "Tunnisteet:"
categories_label : "Kategoriat:"
date_label : "Päivitetty:"
comments_label : "Jätä kommentti"
comments_title : "Kommentit"
more_label : "Lisää"
related_label : "Voit olla kiinnostunut myös"
related_label : "Saatat olla kiinnostunut myös"
follow_label : "Seuraa:"
feed_label : "Syöte"
powered_by : "Voimanlähteenä"
website_label : "Websivu"
email_label : "Email"
recent_posts : "Viimeisimmät postaukset"
powered_by : "Käyttäen"
website_label : "Kotisivu"
email_label : "Sähköposti"
recent_posts : "Viimeisimmät kirjoitukset"
undefined_wpm : "words_per_minute asetusta ei ole määritelty _config.yml tiedostossa"
comment_form_info : "Your email address will not be published. Required fields are marked"
comment_form_info : "Sinun sähköpostiosoitetta ei julkaista. Vaaditut kentät ovat merkittyjä"
comment_form_comment_label : "Kommentti"
comment_form_md_info : "Tukee markdown muotoilua."
comment_form_name_label : "Nimi"
comment_form_email_label : "Email osoite"
comment_form_website_label : "Webbisivu (vapaaehtoinen)"
comment_form_email_label : "Sähköpostiosoite"
comment_form_website_label : "Nettisivu (vapaaehtoinen)"
comment_btn_submit : "Lähetä"
comment_btn_submitted : "Lähetetty"
comment_success_msg : "Kiitos kommentista, se julkaistaan tällä sivulla moderoinnin jälkeen."
comment_error_msg : "Tarkista että olet täyttänyt kaikki kentät ja yritä uudelleen."
comment_success_msg : "Kiitos kommentista, se julkaistaan tällä sivulla tarkastelun jälkeen."
comment_error_msg : "Tapahtui virhe. Tarkista, että olet täyttänyt kaikki kentät ja yritä uudelleen."
loading_label : "Ladataan..."
search_label_text : "Hakusana..."
search_placeholder_text : "Hakusana..."
search_algolia_no_results :
search_algolia_no_results : "Ei hakutuloksia"
results_found : "Tulosta"
back_to_top : "Ylös"
back_to_top : "Siirry ylös"

# Myanmar (Burmese)
# -----------------
Expand Down Expand Up @@ -2019,6 +2022,58 @@ sw-KE:
sw-TZ:
<<: *DEFAULT_SW

# Ukrainian / Українська
# -----------------
uk: &DEFAULT_UK
skip_links : "Посилання для переходу"
skip_primary_nav : "Перейти до основної навігації"
skip_content : "Перейти до змісту"
skip_footer : "Перейти до нижнього колонтитула"
page : "Сторінка"
pagination_previous : "Попередня"
pagination_next : "Наступна"
breadcrumb_home_label : "Головна"
breadcrumb_separator : "/"
menu_label : "Випадаюче меню"
search_label : "Пошук"
toc_label : "Зміст"
ext_link_label : "Пряме посилання"
less_than : "менше ніж"
minute_read : "хв. на чітання"
share_on_label : "Поділитися"
meta_label :
tags_label : "Мітки:"
categories_label : "Розділи:"
date_label : "Дата зміни:"
comments_label : "Залишити коментар"
comments_title : "Коментарі"
more_label : "Читати далі"
related_label : "Вам також може сподобатись"
follow_label : "Зв'язатися зі мною:"
feed_label : "RSS-стрічка"
powered_by : "Сайт працює на"
website_label : "Сайт"
email_label : "Электронна пошта"
recent_posts : "Останні записи"
undefined_wpm : "Не визначено параметр words_per_minute в _config.yml"
comment_form_info : "Вашу адресу електронної пошти не буде опубліковано. Обов'язкові поля позначені"
comment_form_comment_label : "Коментар"
comment_form_md_info : "Підтримується синтаксис Markdown."
comment_form_name_label : "Ім'я"
comment_form_email_label : "Електронна пошта"
comment_form_website_label : "Посилання на сайт (необов'язково)"
comment_btn_submit : "Залишити коментар"
comment_btn_submitted : "Відправлено"
comment_success_msg : "Дякую за Ваш коментар! Його буде опубліковано на сайті після перевірки."
comment_error_msg : "На жаль, сталася помилка з надсиланням коментаря. Будь ласка, переконайтеся, що всі обов'язкові поля заповнені та спробуйте знову."
loading_label : "Відправка..."
search_label_text : "Введіть пошуковий запит..."
search_placeholder_text : "Введіть пошуковий запит..."
search_algolia_no_results :
results_found : "Знайдено"
uk-UA:
<<: *DEFAULT_UK

# Another locale
# --------------
#
Empty file added _includes/after-content.html
Empty file.
Empty file added _includes/before-related.html
Empty file.
2 changes: 1 addition & 1 deletion _includes/breadcrumbs.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
{% else %}
{% assign i = i | plus: 1 %}
<li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">
<a href="{{ crumb | downcase | replace: '%20', '-' | prepend: path_type | prepend: crumb_path | relative_url }}" itemprop="item"><span itemprop="name">{{ crumb | replace: '-', ' ' | replace: '%20', ' ' | capitalize }}</span></a>
<a href="{{ crumb | downcase | replace: '%20', '-' | prepend: path_type | prepend: crumb_path | relative_url }}" itemprop="item"><span itemprop="name">{{ crumb | url_decode | replace: '-', ' ' | capitalize }}</span></a>
<meta itemprop="position" content="{{ i }}" />
</li>
<span class="sep">{{ site.data.ui-text[site.locale].breadcrumb_separator | default: "/" }}</span>
Expand Down
Loading

0 comments on commit de3cc61

Please sign in to comment.