Permalink
Browse files

Update docs

  • Loading branch information...
1 parent 12a0489 commit 03dac00db928588acbaeb8b9fff2ce9f0167195b @mmistakes mmistakes committed Apr 13, 2016
View
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2014 Michael Rose
+Copyright (c) 2016 Michael Rose
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
View
@@ -188,7 +188,7 @@ defaults:
type: docs
values:
layout: single
- read_time: true
+ read_time: false
author_profile: false
share: false
comments: false
@@ -71,7 +71,7 @@ docs:
path: history
- title: "Contributing"
path: contributing
+ - title: "Old 2.2 Docs"
+ path: docs-2-2
- title: "License"
- path: license
- - title: "Old 2.2.1 Docs"
- path: docs-2
+ path: license
@@ -1,12 +1,11 @@
---
title: "Quick-Start Guide"
permalink: /docs/quick-start-guide/
-redirect_from:
- - /docs/
excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
@@ -35,15 +34,15 @@ If you're hosting several Jekyll based sites under the same GitHub username you
## Customize Your Site
-Open up `_config.yml` found in the root of the repo and edit anything under **Site Settings**. For a full explanation of every setting be sure to read the **Customization** section, but for now let's just change the site's title.
+Open up `_config.yml` found in the root of the repo and edit anything under **Site Settings**. For a full explanation of every setting be sure to read the [**Configuration**]({{ base_path }}/docs/configuration/) section, but for now let's just change the site's title.
<figure>
<img src="{{ base_path }}/images/mm-github-edit-config.gif" alt="editing _config.yml file">
<figcaption>Edit text files without leaving GitHub.com</figcaption>
</figure>
-Committing a change to `_config.yml` (or any file in your repository) will force GitHub Pages to rebuild your site with Jekyll. It should then be viewable a few seconds later at <USERNAME.github.io>.
+Committing a change to `_config.yml` (or any file in your repository) will force GitHub Pages to rebuild your site with Jekyll. It should then be viewable a few seconds later at `https://USERNAME.github.io`.
---
-Congratulations! You've successfully forked the Minimal Mistakes Jekyll theme and are up an running with GitHub Pages. Now you're ready to add some content and customize the site further.
+Congratulations! You've successfully forked the theme and are up an running with GitHub Pages. Now you're ready to add content and customize the site further.
View
@@ -5,15 +5,16 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
-Nothing clever here :wink:. Layouts, data files, and includes are all placed in their default locations. Stylesheets and scripts in `assets`, and a few development related files in the root.
+Nothing clever here :wink:. Layouts, data files, and includes are all placed in their default locations. Stylesheets and scripts in `assets`, and a few development related files in the project's root directory.
```bash
minimal-mistakes
├── _data # data files for customizing the theme
| ├── navigations.yml # main navigation links
-| └── ui-text.yml # text used through out the theme's UI
+| └── ui-text.yml # text used throughout the theme's UI
├── _includes
| ├── analytics-providers # snippets for analytics (Google and custom)
| ├── comments-providers # snippets for comments (Disqus, Facebook, Google+, and custom)
@@ -22,9 +23,9 @@ minimal-mistakes
| ├── 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
+| ├── group-by-array # group by array helper for archives
| ├── nav_list # navigation list helper
-| ├── toc # Markdown table of contents helper
+| ├── toc # table of contents helper
| └── ...
├── _layouts
| ├── archive-taxonomy.html # tag/category archive for Jekyll Archives plugin
@@ -34,19 +35,19 @@ minimal-mistakes
| ├── single.html # single document (post/page/etc)
| └── splash.html # splash page
├── assets
-| ├── _scss # stylesheet source in SCSS
+| ├── _scss # stylesheet source files
| | ├── vendor # vendor SCSS partials
-| | ├── main.scss # all SCSS partials are imported here
-| | └── ... # SCSS partials
+| | ├── main.scss # imports all SCSS partials
+| | └── ... # theme SCSS partials
| ├── css
-| | └── main.css # optimized stylesheet for the theme
+| | └── main.css # optimized stylesheet loaded in <head>
| ├── fonts
| | └── fontawesome-webfont # Font Awesome webfonts
| ├── js
| | ├── 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
+| | ├── _main.js # plugin settings and other scripts to load after jQuery
+| | └── main.min.js # optimized and concatenated script file loaded before </body>
├── images # image assets for posts/pages/collections/etc.
├── _config.yml # site configuration
├── Gemfile # gem file dependencies
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
View
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
View
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
View
@@ -10,6 +10,7 @@ single_layout_gallery:
alt: "single layout with header example"
- image_path: mm-layout-single-meta.png
alt: "single layout with comments and related posts"
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
View
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
View
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
View
@@ -30,6 +30,7 @@ feature_row:
- image_path: unsplash-gallery-image-3-th.jpg
title: "Placeholder 3"
excerpt: "This is some sample content that goes here with **Markdown** formatting."
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
@@ -5,6 +5,7 @@ excerpt:
sidebar:
title: "v3.0"
nav: docs
+modified: 2016-04-13T15:54:02-04:00
---
{% include base_path %}
View
@@ -0,0 +1,65 @@
+---
+title: "History"
+permalink: /docs/history/
+excerpt:
+sidebar:
+ title: "v3.0"
+ nav: docs
+modified: 2016-04-13T15:27:39-04:00
+---
+
+## [1.2.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.2.0)
+
+### Bug Fixes
+
+- Table weren't filling the entire width of the content container. They now scale at 100%. Thanks [@dhruvbhatia](https://github.com/dhruvbhatia)
+
+### Enhancements
+
+- Decreased spacing between Markdown footnotes
+- Removed dark background on footer
+- Removed UPPERCASE styling on post titles in the index listing
+
+## [1.1.4](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.1.4)
+
+### Bug Fixes
+
+- Fix top navigation bug issue ([#10](https://github.com/mmistakes/minimal-mistakes/issues/10)) for real this time. Remember to clear your floats kids.
+
+## [1.1.3](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.1.3)
+
+### Bug Fixes
+
+- Fix top navigation links that weren't click able on small viewports (Issue [#10](https://github.com/mmistakes/minimal-mistakes/issues/10)).
+- Remove line wrap from top navigation links that may span multiple lines.
+
+## [1.1.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.1.2)
+
+### Enhancements
+
+- Added Grunt build script for compiling Less/JavaScript and optimizing image assets.
+- Added support for large image summary Twitter card.
+- Stylesheet adjustments
+
+## [1.1.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/1.1.1)
+
+### Bug Fixes
+
+- Removed [Typeplate](http://typeplate.com/) styles. Was [causing issues with newer versions of Less](https://github.com/typeplate/typeplate.github.io/issues/108) and is no longer maintained.
+
+### Enhancements
+
+- Added [image attribution](http://mmistakes.github.io/minimal-mistakes/theme-setup/#feature-images) for post and page feature images.
+- Added [404 page](http://mmistakes.github.io/minimal-mistakes/404.html).
+- Cleaned up various Less variables to better align with naming conventions used in other MM Jekyll themes.
+- Removed Chrome Frame references.
+- Added global CSS3 transitions to text and block elements.
+- Improved typography in a few places.
+
+## [1.0.2](https://github.com/mmistakes/minimal-mistakes/releases/tag/v1.0.2)
+
+### Enhancements
+
+- Google Analytics, Google Authorship, webmaster verifies, and Twitter card meta are now optional.
+
+## [1.0.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/v1.0.1)
@@ -0,0 +1,15 @@
+---
+title: "Contributing"
+permalink: /docs/contributing/
+excerpt:
+sidebar:
+ title: "v3.0"
+ nav: docs
+modified: 2016-04-13T15:54:02-04:00
+---
+
+Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature or [fixing a bug]({{ site.gh_repo }}/issues)? Then by all means [submit an issue]({{ site.gh_repo }}/issues/new) or [pull request]({{ site.gh_repo }}/compare). If this is your first pull request, it may help to read up on the [GitHub Flow](https://guides.github.com/introduction/flow/).
+
+As the theme's name implies I'd like to keep it as minimal as possible. It has been designed as a base for you to build off of.
+
+Please keep this in mind when requesting features and/or submitting pull requests. If it's not something that most people will use, I probably won't consider it. When in doubt ask :smile:.
Oops, something went wrong.

0 comments on commit 03dac00

Please sign in to comment.