-
Notifications
You must be signed in to change notification settings - Fork 26.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'mmistakes:master' into update
- Loading branch information
Showing
48 changed files
with
1,843 additions
and
1,428 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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] | ||
|
@@ -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) | ||
|
||
|
@@ -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. | ||
|
@@ -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 | ||
|
@@ -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/) | ||
|
||
|
@@ -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) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.