Update docs
This commit is contained in:
parent
12a0489256
commit
03dac00db9
24 changed files with 164 additions and 61 deletions
2
LICENSE
2
LICENSE
|
@ -1,6 +1,6 @@
|
||||||
The MIT License (MIT)
|
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
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
|
@ -188,7 +188,7 @@ defaults:
|
||||||
type: docs
|
type: docs
|
||||||
values:
|
values:
|
||||||
layout: single
|
layout: single
|
||||||
read_time: true
|
read_time: false
|
||||||
author_profile: false
|
author_profile: false
|
||||||
share: false
|
share: false
|
||||||
comments: false
|
comments: false
|
||||||
|
|
|
@ -71,7 +71,7 @@ docs:
|
||||||
path: history
|
path: history
|
||||||
- title: "Contributing"
|
- title: "Contributing"
|
||||||
path: contributing
|
path: contributing
|
||||||
|
- title: "Old 2.2 Docs"
|
||||||
|
path: docs-2-2
|
||||||
- title: "License"
|
- title: "License"
|
||||||
path: license
|
path: license
|
||||||
- title: "Old 2.2.1 Docs"
|
|
||||||
path: docs-2
|
|
|
@ -1,12 +1,11 @@
|
||||||
---
|
---
|
||||||
title: "Quick-Start Guide"
|
title: "Quick-Start Guide"
|
||||||
permalink: /docs/quick-start-guide/
|
permalink: /docs/quick-start-guide/
|
||||||
redirect_from:
|
|
||||||
- /docs/
|
|
||||||
excerpt:
|
excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
@ -35,15 +34,15 @@ If you're hosting several Jekyll based sites under the same GitHub username you
|
||||||
|
|
||||||
## Customize Your Site
|
## 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>
|
<figure>
|
||||||
<img src="{{ base_path }}/images/mm-github-edit-config.gif" alt="editing _config.yml file">
|
<img src="{{ base_path }}/images/mm-github-edit-config.gif" alt="editing _config.yml file">
|
||||||
<figcaption>Edit text files without leaving GitHub.com</figcaption>
|
<figcaption>Edit text files without leaving GitHub.com</figcaption>
|
||||||
</figure>
|
</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.
|
|
@ -5,15 +5,16 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
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
|
```bash
|
||||||
minimal-mistakes
|
minimal-mistakes
|
||||||
├── _data # data files for customizing the theme
|
├── _data # data files for customizing the theme
|
||||||
| ├── navigations.yml # main navigation links
|
| ├── 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
|
├── _includes
|
||||||
| ├── analytics-providers # snippets for analytics (Google and custom)
|
| ├── analytics-providers # snippets for analytics (Google and custom)
|
||||||
| ├── comments-providers # snippets for comments (Disqus, Facebook, 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
|
| ├── base_path # site.url + site.baseurl shortcut
|
||||||
| ├── feature_row # feature row helper
|
| ├── feature_row # feature row helper
|
||||||
| ├── gallery # image gallery 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
|
| ├── nav_list # navigation list helper
|
||||||
| ├── toc # Markdown table of contents helper
|
| ├── toc # table of contents helper
|
||||||
| └── ...
|
| └── ...
|
||||||
├── _layouts
|
├── _layouts
|
||||||
| ├── archive-taxonomy.html # tag/category archive for Jekyll Archives plugin
|
| ├── archive-taxonomy.html # tag/category archive for Jekyll Archives plugin
|
||||||
|
@ -34,19 +35,19 @@ minimal-mistakes
|
||||||
| ├── single.html # single document (post/page/etc)
|
| ├── single.html # single document (post/page/etc)
|
||||||
| └── splash.html # splash page
|
| └── splash.html # splash page
|
||||||
├── assets
|
├── assets
|
||||||
| ├── _scss # stylesheet source in SCSS
|
| ├── _scss # stylesheet source files
|
||||||
| | ├── vendor # vendor SCSS partials
|
| | ├── vendor # vendor SCSS partials
|
||||||
| | ├── main.scss # all SCSS partials are imported here
|
| | ├── main.scss # imports all SCSS partials
|
||||||
| | └── ... # SCSS partials
|
| | └── ... # theme SCSS partials
|
||||||
| ├── css
|
| ├── css
|
||||||
| | └── main.css # optimized stylesheet for the theme
|
| | └── main.css # optimized stylesheet loaded in <head>
|
||||||
| ├── fonts
|
| ├── fonts
|
||||||
| | └── fontawesome-webfont # Font Awesome webfonts
|
| | └── fontawesome-webfont # Font Awesome webfonts
|
||||||
| ├── js
|
| ├── js
|
||||||
| | ├── plugins # jQuery plugins
|
| | ├── plugins # jQuery plugins
|
||||||
| | ├── vendor # vendor scripts
|
| | ├── vendor # vendor scripts
|
||||||
| | ├── _main.js # scripts to be loaded after jQuery and plugins
|
| | ├── _main.js # plugin settings and other scripts to load after jQuery
|
||||||
| | └── main.min.js # optimized and concatenated script file for the theme
|
| | └── main.min.js # optimized and concatenated script file loaded before </body>
|
||||||
├── images # image assets for posts/pages/collections/etc.
|
├── images # image assets for posts/pages/collections/etc.
|
||||||
├── _config.yml # site configuration
|
├── _config.yml # site configuration
|
||||||
├── Gemfile # gem file dependencies
|
├── Gemfile # gem file dependencies
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -10,6 +10,7 @@ single_layout_gallery:
|
||||||
alt: "single layout with header example"
|
alt: "single layout with header example"
|
||||||
- image_path: mm-layout-single-meta.png
|
- image_path: mm-layout-single-meta.png
|
||||||
alt: "single layout with comments and related posts"
|
alt: "single layout with comments and related posts"
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -30,6 +30,7 @@ feature_row:
|
||||||
- image_path: unsplash-gallery-image-3-th.jpg
|
- image_path: unsplash-gallery-image-3-th.jpg
|
||||||
title: "Placeholder 3"
|
title: "Placeholder 3"
|
||||||
excerpt: "This is some sample content that goes here with **Markdown** formatting."
|
excerpt: "This is some sample content that goes here with **Markdown** formatting."
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
|
@ -5,6 +5,7 @@ excerpt:
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
65
_docs/17-history.md
Normal file
65
_docs/17-history.md
Normal file
|
@ -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)
|
15
_docs/18-contributing.md
Normal file
15
_docs/18-contributing.md
Normal file
|
@ -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:.
|
|
@ -1,9 +1,11 @@
|
||||||
---
|
---
|
||||||
title: "v2 Documentation"
|
title: "2.2 Documentation"
|
||||||
excerpt: "Minimal Mistakes Jekyll theme version 2 setup and installation instructions."
|
permalink: /docs/docs-2-2/
|
||||||
|
excerpt: "Minimal Mistakes Jekyll Theme v2.2 setup and installation instructions."
|
||||||
sidebar:
|
sidebar:
|
||||||
title: "v3.0"
|
title: "v3.0"
|
||||||
nav: docs
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:54:02-04:00
|
||||||
---
|
---
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
@ -22,7 +24,7 @@ If you are creating a new Jekyll site using Minimal Mistakes follow these steps:
|
||||||
|
|
||||||
If you want to use Minimal Mistakes with an existing Jekyll site follow these steps:
|
If you want to use Minimal Mistakes with an existing Jekyll site follow these steps:
|
||||||
|
|
||||||
1. [Download Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes/archive/master.zip) and unzip.
|
1. [Download Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes/releases/tag/2.2.1) and unzip.
|
||||||
2. Rename `minimal-mistakes-master` to something meaningful ie: `new-site`
|
2. Rename `minimal-mistakes-master` to something meaningful ie: `new-site`
|
||||||
3. Run `bundle install` to install all dependencies (Jekyll, [Jekyll-Sitemap](https://github.com/jekyll/jekyll-sitemap), [Octopress](https://github.com/octopress/octopress), etc)
|
3. Run `bundle install` to install all dependencies (Jekyll, [Jekyll-Sitemap](https://github.com/jekyll/jekyll-sitemap), [Octopress](https://github.com/octopress/octopress), etc)
|
||||||
4. Remove demo posts/pages and replace with your own posts, pages, and any other content you want to move over.
|
4. Remove demo posts/pages and replace with your own posts, pages, and any other content you want to move over.
|
||||||
|
@ -32,8 +34,6 @@ If you want to use Minimal Mistakes with an existing Jekyll site follow these st
|
||||||
**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo site that I'm guessing you won't want.
|
**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo site that I'm guessing you won't want.
|
||||||
{: .notice}
|
{: .notice}
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Running Jekyll
|
## Running Jekyll
|
||||||
|
|
||||||
The preferred method for running Jekyll is with `bundle exec`, but if you're willing to deal gem conflicts feel free to go cowboy with a `jekyll serve` or `jekyll build`.
|
The preferred method for running Jekyll is with `bundle exec`, but if you're willing to deal gem conflicts feel free to go cowboy with a `jekyll serve` or `jekyll build`.
|
||||||
|
@ -46,8 +46,6 @@ The preferred method for running Jekyll is with `bundle exec`, but if you're wil
|
||||||
bundle exec jekyll serve
|
bundle exec jekyll serve
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Scaffolding
|
## Scaffolding
|
||||||
|
|
||||||
How Minimal Mistakes is organized and what the various files are. All posts, layouts, includes, stylesheets, assets, and whatever else is grouped nicely under the root folder. The compiled Jekyll site outputs to `_site/`.
|
How Minimal Mistakes is organized and what the various files are. All posts, layouts, includes, stylesheets, assets, and whatever else is grouped nicely under the root folder. The compiled Jekyll site outputs to `_site/`.
|
||||||
|
@ -89,8 +87,6 @@ minimal-mistakes/
|
||||||
└── theme-setup/ # theme setup page. safe to remove
|
└── theme-setup/ # theme setup page. safe to remove
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Site Setup
|
## Site Setup
|
||||||
|
|
||||||
A quick checklist of the files you'll want to edit to get up and running.
|
A quick checklist of the files you'll want to edit to get up and running.
|
||||||
|
@ -134,8 +130,6 @@ To set what links appear in the top navigation edit `_data/navigation.yml`. Use
|
||||||
url: http://mademistakes.com
|
url: http://mademistakes.com
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Adding New Content with Octopress
|
## Adding New Content with Octopress
|
||||||
|
|
||||||
While completely optional, I've included Octopress and some starter templates to automate the creation of new posts and pages. To take advantage of it start by installing the [Octopress](https://github.com/octopress/octopress) gem if it isn't already.
|
While completely optional, I've included Octopress and some starter templates to automate the creation of new posts and pages. To take advantage of it start by installing the [Octopress](https://github.com/octopress/octopress) gem if it isn't already.
|
||||||
|
@ -168,8 +162,6 @@ $ octopress new page new-page/
|
||||||
|
|
||||||
This will create a page at `/new-page/index.md`
|
This will create a page at `/new-page/index.md`
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Layouts and Content
|
## Layouts and Content
|
||||||
|
|
||||||
Explanations of the various `_layouts` included with the theme and when to use them.
|
Explanations of the various `_layouts` included with the theme and when to use them.
|
||||||
|
@ -298,8 +290,6 @@ Not sure if this only effects Kramdown or if it's an issue with Markdown in gene
|
||||||
|
|
||||||
Social sharing links for Twitter, Facebook, and Google+ are included on posts/pages by default. To hide them on specific posts or pages add `share: false` to the YAML Front Matter. If you'd like to use different social networks modify `_includes/social-share` to your liking. Icons are set using [Font Awesome](http://fontawesome.io).
|
Social sharing links for Twitter, Facebook, and Google+ are included on posts/pages by default. To hide them on specific posts or pages add `share: false` to the YAML Front Matter. If you'd like to use different social networks modify `_includes/social-share` to your liking. Icons are set using [Font Awesome](http://fontawesome.io).
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Further Customization
|
## Further Customization
|
||||||
|
|
||||||
Jekyll 2.x added support for Sass files making it much easier to modify a theme's fonts and colors. By editing values found in `_sass/variables.scss` you can fine tune the site's colors and typography.
|
Jekyll 2.x added support for Sass files making it much easier to modify a theme's fonts and colors. By editing values found in `_sass/variables.scss` you can fine tune the site's colors and typography.
|
||||||
|
@ -312,16 +302,4 @@ To modify the site's JavaScript files I setup a Grunt build script to lint/conca
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
From the theme's root, use `grunt` concatenate JavaScript files, and optimize .jpg, .png, and .svg files in the `images/` folder. You can also use `grunt dev` in combination with `jekyll build --watch` to watch for updates JS files that Grunt will then automatically re-build as you write your code which will in turn auto-generate your Jekyll site when developing locally.
|
From the theme's root, use `grunt` concatenate JavaScript files, and optimize .jpg, .png, and .svg files in the `images/` folder. You can also use `grunt dev` in combination with `jekyll build --watch` to watch for updates JS files that Grunt will then automatically re-build as you write your code which will in turn auto-generate your Jekyll site when developing locally.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Questions?
|
|
||||||
|
|
||||||
Found a bug or aren't quite sure how something works? By all means Ping me on Twitter [@mmistakes](http://twitter.com/mmistakes) or [file a GitHub Issue](https://github.com/mmistakes/minimal-mistakes/issues/new). And if you make something cool with this theme feel free to let me know.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
This theme is free and open source software, distributed under the MIT License. So feel free to use this Jekyll theme on your site without linking back to me or including a disclaimer.
|
|
31
_docs/20-license.md
Normal file
31
_docs/20-license.md
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
---
|
||||||
|
title: "License"
|
||||||
|
permalink: /docs/license/
|
||||||
|
excerpt:
|
||||||
|
sidebar:
|
||||||
|
title: "v3.0"
|
||||||
|
nav: docs
|
||||||
|
modified: 2016-04-13T15:05:12-04:00
|
||||||
|
---
|
||||||
|
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) {{ site.time | date: '%Y' }} 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
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
|
@ -4,28 +4,28 @@ layout: compress
|
||||||
|
|
||||||
{% include base_path %}
|
{% include base_path %}
|
||||||
|
|
||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="{{ site.locale | slice: 0,2 }}" class="no-js">
|
<html lang="{{ site.locale | slice: 0,2 }}" class="no-js">
|
||||||
<head>
|
<head>
|
||||||
{% include head.html %}
|
{% include head.html %}
|
||||||
{% include head/custom.html %}
|
{% include head/custom.html %}
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
|
|
||||||
{% include browser-upgrade.html %}
|
{% include browser-upgrade.html %}
|
||||||
{% include masthead.html %}
|
{% include masthead.html %}
|
||||||
|
|
||||||
{{ content }}
|
{{ content }}
|
||||||
|
|
||||||
<div class="page__footer">
|
<div class="page__footer">
|
||||||
<footer>
|
<footer>
|
||||||
{% include footer.html %}
|
{% include footer.html %}
|
||||||
</footer>
|
</footer>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{% include scripts.html %}
|
{% include scripts.html %}
|
||||||
{% include footer/custom.html %}
|
{% include footer/custom.html %}
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
Loading…
Reference in a new issue