Add images to docs

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

View File

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

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.
**<< 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.
@ -40,6 +43,8 @@ If you're not planning on hosting with GitHub Pages and want to leverage feature
$ 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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB