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

Add images to docs

Browse source
This commit is contained in:
Michael Rose 2016-04-04 21:16:25 -04:00
parent 4f3733f0fe
commit 341e523283
4 changed files with 42 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
_docs/02-structure.md
View file

@ -10,46 +10,46 @@ For consistency, Minimal Mistake's folder and file structure tries to remain clo
```bash ```bash
minimal-mistakes minimal-mistakes
├── _data ├── _data # data files for customizing the theme
| ├── navigations.yml | ├── navigations.yml # main navigation links
| └── ui-text.yml | └── ui-text.yml # text used through out the theme's UI
├── _includes ├── _includes
| ├── analytics-providers | ├── analytics-providers # snippets for analytics (Google and custom)
| ├── comments-providers | ├── comments-providers # snippets for comments (Disqus, Facebook, Google+, and custom)
| ├── footer | ├── footer # custom snippets to add to site footer
| ├── head | ├── head # custom snippets to add to site head
| ├── base_path | ├── base_path # site.url + site.baseurl shortcut
| ├── feature-row | ├── feature_row # feature row helper
| ├── gallery | ├── gallery # image gallery helper
| ├── group-by-array | ├── group-by-array # group by array helper for index listings
| ├── nav_list | ├── nav_list # navigation list helper
| ├── toc | ├── toc # Markdown table of contents helper
| └── ... | └── ...
├── _layouts ├── _layouts
| ├── archive-taxonomy.html | ├── archive-taxonomy.html # tag/category archive for Jekyll Archives plugin
| ├── archive.html | ├── archive.html # archive listing documents in an array
| ├── compress.html | ├── compress.html # compresses HTML in pure Liquid
| ├── default.html | ├── default.html # base for all other layouts
| ├── single.html | ├── single.html # single document (post/page/etc)
| └── splash.html | └── splash.html # splash page
├── assets ├── assets
| ├── _scss | ├── _scss # stylesheet source in SCSS
| | ├── vendor | | ├── vendor # vendor SCSS partials
| | ├── main.scss | | ├── main.scss # all SCSS partials are imported here
| | └── ... | | └── ... # SCSS partials
| ├── css | ├── css
| | └── main.css | | └── main.css # optimized stylesheet for the theme
| ├── fonts | ├── fonts
| | └── fontawesome-webfont | | └── fontawesome-webfont # Font Awesome webfonts
| ├── js | ├── js
| | ├── plugins | | ├── plugins # jQuery plugins
| | ├── vendor | | ├── vendor # vendor scripts
| | ├── _main.js | | ├── _main.js # scripts to be loaded after jQuery and plugins
| | └── main.min.js | | └── main.min.js # optimized and concatenated script file for the theme
├── assets ├── images # image assets for posts/pages/collections/etc.
├── _config.yml ├── _config.yml # site configuration
├── Gemfile ├── Gemfile # gem file dependencies
├── Gemfile.lock ├── Gemfile.lock # gem file dependencies
├── index.html ├── index.html # paginated home page showing recent posts
└── package.json └── package.json # NPM build scripts
``` ```

9
_docs/03-installation.md
View file

@ -17,7 +17,10 @@ The easiest being: fork the Minimal Mistakes repo on GitHub. If you plan on host
For an existing site you have some more work ahead of you. What I suggest is to fork and rename the theme as before, then clone it by running `git clone https://github.com/USERNAME/REPONAME.git` --- replacing **USERNAME** and **REPONAME** with yours. For an existing site you have some more work ahead of you. What I suggest is to fork and rename the theme as before, then clone it by running `git clone https://github.com/USERNAME/REPONAME.git` --- replacing **USERNAME** and **REPONAME** with yours.
**<< insert screenshot showing where to copy the repo's URL on GitHub >>** <figure>
<img src="{{ base_path }}/images/mm-github-copy-repo-url.png" alt="copy GitHub repo URL">
<figcaption>Tap the copy to clipboard button, outlined in red above.</figcaption>
</figure>
Then depending on how much existing content you're moving over begin the process of copying and converting everything. In most cases you simply need to update the settings in `_config.yml` to your liking and set the correct `layout` in the YAML Front Matter. Then depending on how much existing content you're moving over begin the process of copying and converting everything. In most cases you simply need to update the settings in `_config.yml` to your liking and set the correct `layout` in the YAML Front Matter.
@ -40,6 +43,8 @@ If you're not planning on hosting with GitHub Pages and want to leverage feature
$ bundle install $ bundle install
``` ```
**<< insert screenshot of Terminal running bundle install >>** <figure>
<img src="{{ base_path }}/images/mm-bundle-install.gif" alt="bundle install in Terminal window">
</figure>
Depending on what gems you already have installed you may have to run `bundle update` to clear up any dependency issues. Bundler is usually pretty good at letting you know what the issue is to work through them. Depending on what gems you already have installed you may have to run `bundle update` to clear up any dependency issues. Bundler is usually pretty good at letting you know what the issue is to work through them.

BIN
images/mm-bundle-install.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 76 KiB

BIN
images/mm-github-copy-repo-url.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 7.5 KiB