N-archive/hacks-guide-minimal-mistakes-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update documentation

Browse source
This commit is contained in:
Michael Rose 2019-08-20 21:36:49 -04:00
parent 143bb32a95
commit 58f1d16900
3 changed files with 4 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/_docs/01-quick-start-guide.md
View file

@ -2,7 +2,7 @@
title: "Quick-Start Guide"
permalink: /docs/quick-start-guide/
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
last_modified_at: 2019-04-18T15:53:52-04:00
last_modified_at: 2019-08-20T21:36:11-04:00
redirect_from:
- /theme-setup/
toc: true
@ -138,8 +138,7 @@ Starting with an empty folder and `Gemfile` you'll need to copy or re-create thi
From `v4.5.0` onwards, Minimal Mistakes theme-gem comes bundled with the necessary data files and will automatically use them via the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin. So you no longer need to maintain a copy of these data files at your project directory.
However like all other bundled files, you'll need to create and edit these data files to customize them.
The bundled data files are:
You'll need to create and edit these data files to customize them:
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | relative_url }})
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | relative_url }})

4
docs/_docs/03-installation.md
View file

@ -2,7 +2,7 @@
title: "Installation"
permalink: /docs/installation/
excerpt: "Instructions for installing the theme for new and existing Jekyll based sites."
last_modified_at: 2018-11-25T19:32:34-05:00
last_modified_at: 2019-08-20T21:36:18-04:00
toc: true
---
@ -81,8 +81,6 @@ gem "minimal-mistakes-jekyll"
# gem "jekyll-sitemap"
# gem "jekyll-gist"
# gem "jekyll-feed"
# gem "jemoji"
# gem "jekyll-data"
# gem "jekyll-include-cache"
#
# If you have any other plugins, put them here!

4
docs/_docs/05-configuration.md
View file

@ -2,7 +2,7 @@
title: "Configuration"
permalink: /docs/configuration/
excerpt: "Settings for configuring and customizing the theme."
last_modified_at: 2019-07-24T10:15:47-04:00
last_modified_at: 2019-08-20T21:36:28-04:00
toc: true
---
@ -950,14 +950,12 @@ When hosting with GitHub Pages a small [set of gems](https://pages.github.com/ve
| [jekyll-sitemap][jekyll-sitemap] | Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site. |
| [jekyll-gist][jekyll-gist] | Liquid tag for displaying GitHub Gists in Jekyll sites. |
| [jekyll-feed][jekyll-feed] | A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts. |
| [jemoji][jemoji] | GitHub-flavored emoji plugin for Jekyll. |
| [jekyll-include-cache][jekyll-include-cache] | Liquid tag that caches Liquid includes. |
[jekyll-paginate]: https://github.com/jekyll/jekyll-paginate
[jekyll-sitemap]: https://github.com/jekyll/jekyll-sitemap
[jekyll-gist]: https://github.com/jekyll/jekyll-gist
[jekyll-feed]: https://github.com/jekyll/jekyll-feed
[jemoji]: https://github.com/jekyll/jemoji
[jekyll-include-cache]: https://github.com/benbalter/jekyll-include-cache
If you're hosting elsewhere then you don't really have to worry about what is whitelisted as you are free to include whatever [Jekyll plugins](https://jekyllrb.com/docs/plugins/) you desire.