|
1 | | -# [Minimal Mistakes Jekyll theme](https://mmistakes.github.io/minimal-mistakes/) |
| 1 | +# [DotNetDevs.at](https://dotnetdevs.at) |
2 | 2 |
|
3 | | -[](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE) |
4 | | -[](https://jekyllrb.com/) |
| 3 | +Build with: |
| 4 | +- Minimal Mistakes [](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE) |
| 5 | +- [](https://jekyllrb.com/) |
5 | 6 |
|
6 | | -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:. |
7 | 7 |
|
8 | | -:sparkles: See what's new in the [CHANGELOG](CHANGELOG.md). |
9 | | - |
10 | | -**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. |
11 | | - |
12 | | -[![Minimal Mistakes live preview][2]][1] |
13 | | - |
14 | | -[1]: https://mmistakes.github.io/minimal-mistakes/ |
15 | | -[2]: screenshot.png (live preview) |
16 | | - |
17 | | - |
18 | | - |
19 | | -## Notable features |
20 | | - |
21 | | -- Bundled as a "theme gem" for easier installation/upgrading. |
22 | | -- Compatible with GitHub Pages. |
23 | | -- Support for Jekyll's built-in Sass/SCSS preprocessor. |
24 | | -- Nine different skins (color variations). |
25 | | -- Several responsive layout options (single, archive index, search, splash, and paginated home page). |
26 | | -- Optimized for search engines with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data. |
27 | | -- 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. |
28 | | -- 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/)). |
29 | | -- [Google Analytics](https://www.google.com/analytics/) support. |
30 | | -- UI localized text in English (default), Arabic (عربي), Brazilian Portuguese (Português brasileiro), Bulgarian, Catalan, Chinese, Czech, 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. |
31 | | - |
32 | | -## Skins (color variations) |
33 | | - |
34 | | -This theme comes in nine different skins (in addition to the default one). |
35 | | - |
36 | | -| `air` | `contrast` | `dark` | |
37 | | -| --- | --- | --- | |
38 | | -| [](https://mmistakes.github.io/minimal-mistakes/assets/images/air-skin-archive-large.png) | [](https://mmistakes.github.io/minimal-mistakes/assets/images/contrast-skin-archive-large.png) | [](https://mmistakes.github.io/minimal-mistakes/assets/images/dark-skin-archive-large.png) | |
39 | | - |
40 | | -| `dirt` | `mint` | `sunrise` | |
41 | | -| --- | --- | --- | |
42 | | -| [](https://mmistakes.github.io/minimal-mistakes/assets/images/dirt-skin-archive-large.png) | [](https://mmistakes.github.io/minimal-mistakes/assets/images/mint-skin-archive-large.png) | [](https://mmistakes.github.io/minimal-mistakes/assets/images/sunrise-skin-archive-large.png) | |
43 | | - |
44 | | -| `aqua` | `neon` | `plum` | |
45 | | -| --- | --- | --- | |
46 | | -| [](https://mmistakes.github.io/minimal-mistakes/assets/images/aqua-skin-archive-large.png) | [](https://mmistakes.github.io/minimal-mistakes/assets/images/neon-skin-archive-large.png) | [](https://mmistakes.github.io/minimal-mistakes/assets/images/plum-skin-archive-large.png) | |
47 | | - |
48 | | -## Demo pages |
49 | | - |
50 | | -| Name | Description | |
51 | | -| ------------------------------------------- | ----------------------------------------------------- | |
52 | | -| [Post with Header Image][header-image-post] | A post with a large header image. | |
53 | | -| [HTML Tags and Formatting Post][html-tags-post] | A variety of common markup showing how the theme styles them. | |
54 | | -| [Syntax Highlighting Post][syntax-post] | Post displaying highlighted code. | |
55 | | -| [Post with a Gallery][gallery-post] | A post showing several images wrapped in `<figure>` elements. | |
56 | | -| [Sample Collection Page][sample-collection] | Single page from a collection. | |
57 | | -| [Categories Archive][categories-archive] | Posts grouped by category. | |
58 | | -| [Tags Archive][tags-archive] | Posts grouped by tag. | |
59 | | - |
60 | | -Additional sample posts are available under [posts archive][year-archive] on the demo site. Source files for these (and the entire demo site) can be found in [`/docs`](docs). |
61 | | - |
62 | | -[header-image-post]: https://mmistakes.github.io/minimal-mistakes/layout-header-image-text-readability/ |
63 | | -[gallery-post]: https://mmistakes.github.io/minimal-mistakes/post%20formats/post-gallery/ |
64 | | -[html-tags-post]: https://mmistakes.github.io/minimal-mistakes/markup/markup-html-tags-and-formatting/ |
65 | | -[syntax-post]: https://mmistakes.github.io/minimal-mistakes/markup-syntax-highlighting/ |
66 | | -[sample-collection]: https://mmistakes.github.io/minimal-mistakes/recipes/chocolate-chip-cookies/ |
67 | | -[categories-archive]: https://mmistakes.github.io/minimal-mistakes/categories/ |
68 | | -[tags-archive]: https://mmistakes.github.io/minimal-mistakes/tags/ |
69 | | -[year-archive]: https://mmistakes.github.io/minimal-mistakes/year-archive/ |
70 | | - |
71 | | -## Installation |
72 | | - |
73 | | -There are three ways to install: as a [gem-based theme](https://jekyllrb.com/docs/themes/#understanding-gem-based-themes), as a [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) (GitHub Pages compatible), or forking/directly copying all of the theme files into your project. |
74 | | - |
75 | | -### Gem-based method |
76 | | - |
77 | | -With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`, and `_sass` are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process. |
78 | | - |
79 | | -This allows for easier installation and updating as you don't have to manage any of the theme files. To install: |
80 | | - |
81 | | -1. Add the following to your `Gemfile`: |
82 | | - |
83 | | - ```ruby |
84 | | - gem "minimal-mistakes-jekyll" |
85 | | - ``` |
86 | | - |
87 | | -2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command: |
88 | | - |
89 | | - ```bash |
90 | | - bundle |
91 | | - ``` |
92 | | - |
93 | | -3. Set the `theme` in your project's Jekyll `_config.yml` file: |
94 | | - |
95 | | - ```yaml |
96 | | - theme: minimal-mistakes-jekyll |
97 | | - ``` |
98 | | -
|
99 | | -To update the theme run `bundle update`. |
100 | | - |
101 | | -### Remote theme method |
102 | | - |
103 | | -Remote themes are similar to Gem-based themes, but do not require `Gemfile` changes or whitelisting making them ideal for sites hosted with GitHub Pages. |
104 | | - |
105 | | -To install: |
106 | | - |
107 | | -1. Create/replace the contents of your `Gemfile` with the following: |
108 | | - |
109 | | - ```ruby |
110 | | - source "https://rubygems.org" |
111 | | -
|
112 | | - gem "github-pages", group: :jekyll_plugins |
113 | | - gem "jekyll-include-cache", group: :jekyll_plugins |
114 | | - ``` |
115 | | - |
116 | | -2. Add `jekyll-include-cache` to the `plugins` array of your `_config.yml`. |
117 | | - |
118 | | -3. Fetch and update bundled gems by running the following [Bundler](https://bundler.io/) command: |
119 | | - |
120 | | - ```bash |
121 | | - bundle |
122 | | - ``` |
123 | | - |
124 | | -4. Add `remote_theme: "mmistakes/minimal-mistakes@4.27.2"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry. |
125 | | - |
126 | | -<!-- |
127 | | - Dev note: The version number is currently hard-coded in these files: |
128 | | - |
129 | | - - package.json |
130 | | - - README.md (this file) |
131 | | - - docs/_data/theme.yml |
132 | | - - docs/_pages/home.md (in Front Matter "excerpt") |
133 | | - |
134 | | - `package.json` holds the authoritative version number, and the others can be updated with `bundle exec rake version`. |
135 | | - |
136 | | - The following files should also be regenerated: |
137 | | - |
138 | | - - _includes/copyright.html, _includes/copyright.js, _sass/minimal-mistakes/_copyright.scss |
139 | | - (Run `bundle exec rake clean` then `bundle exec rake copyright` - all three references `package.json`) |
140 | | - - assets/js/main.min.js (Run `bundle exec rake js`, references `_includes/copyright.js`) |
141 | | - |
142 | | - *Tip*: The default Rake task will update all of the above files at once. |
143 | | - |
144 | | - Additionally, the license year is hard-coded in these files and are NOT covered by a Rake task: |
145 | | - |
146 | | - - README.md (this file, near the end) |
147 | | - - LICENSE |
148 | | ---> |
149 | | - |
150 | | -**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. |
151 | | - |
152 | | -## Usage |
153 | | - |
154 | | -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/). |
155 | | - |
156 | | -## Contributing |
157 | | - |
158 | | -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. |
159 | | - |
160 | | -For help with using the theme or general Jekyll support questions, please use the [Jekyll Talk forums](https://talk.jekyllrb.com/). |
161 | | - |
162 | | -### Pull Requests |
163 | | - |
164 | | -When submitting a pull request: |
165 | | - |
166 | | -1. Clone the repo. |
167 | | -2. Create a branch off of `master` and give it a meaningful name (e.g. `my-awesome-new-feature`). |
168 | | -3. Open a pull request on GitHub and describe the feature or fix. |
169 | | - |
170 | | -Theme documentation and demo pages can be found in the [`/docs`](docs) if submitting improvements, typo corrections, etc. |
171 | | - |
172 | | -## Development |
173 | | - |
174 | | -To set up your environment to develop this theme, run `bundle install`. |
175 | | - |
176 | | -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. |
177 | | - |
178 | | -## Credits |
179 | | - |
180 | | -### Creator |
181 | | - |
182 | | -**Michael Rose** |
183 | | - |
184 | | -- <https://mademistakes.com> |
185 | | -- <https://twitter.com/mmistakes> |
186 | | -- <https://github.com/mmistakes> |
187 | | - |
188 | | -### Icons + Demo Images: |
189 | | - |
190 | | -- [The Noun Project](https://thenounproject.com) - Garrett Knoll, Arthur Shlain, and [tracy tam](https://thenounproject.com/tracytam) |
191 | | -- [Font Awesome](http://fontawesome.io/) |
192 | | -- [Unsplash](https://unsplash.com/) |
193 | | - |
194 | | -### Other: |
195 | | - |
196 | | -- [Jekyll](http://jekyllrb.com/) |
197 | | -- [jQuery](http://jquery.com/) |
198 | | -- [Susy](http://susy.oddbird.net/) |
199 | | -- [Breakpoint](http://breakpoint-sass.com/) |
200 | | -- [Magnific Popup](http://dimsemenov.com/plugins/magnific-popup/) |
201 | | -- [FitVids.JS](http://fitvidsjs.com/) |
202 | | -- [GreedyNav.js](https://github.com/lukejacksonn/GreedyNav) |
203 | | -- [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll) |
204 | | -- [Gumshoe](https://github.com/cferdinandi/gumshoe) |
205 | | -- [jQuery throttle / debounce](http://benalman.com/projects/jquery-throttle-debounce-plugin/) |
206 | | -- [Lunr](http://lunrjs.com) |
207 | | -- [Clipboard.js](https://clipboardjs.com) |
208 | | - |
209 | | -## License |
| 8 | +## Minimal Mistakes License |
210 | 9 |
|
211 | 10 | The MIT License (MIT) |
212 | 11 |
|
|
0 commit comments