Sebastian Wiesner
committed by
Michael Rose
Michael Rose
parent
805dad0077
commit
cf4f8277c1
@@ -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."
|
||||
modified: 2016-11-03T10:01:43-04:00
|
||||
last_modified_at: 2016-11-03T10:01:43-04:00
|
||||
redirect_from:
|
||||
- /theme-setup/
|
||||
---
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Structure"
|
||||
permalink: /docs/structure/
|
||||
excerpt: "How the theme is organized and what all of the files are for."
|
||||
modified: 2016-10-06T22:39:43-04:00
|
||||
last_modified_at: 2016-10-06T22:39:43-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 project's root directory.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Installation"
|
||||
permalink: /docs/installation/
|
||||
excerpt: "Instructions for installing the theme for new and existing Jekyll based sites."
|
||||
modified: 2016-11-03T10:13:32-04:00
|
||||
last_modified_at: 2016-11-03T10:13:32-04:00
|
||||
---
|
||||
|
||||
## Install the Theme
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Upgrading"
|
||||
permalink: /docs/upgrading/
|
||||
excerpt: "Instructions and suggestions for upgrading the theme."
|
||||
modified: 2016-11-03T10:16:34-04:00
|
||||
last_modified_at: 2016-11-03T10:16:34-04:00
|
||||
---
|
||||
|
||||
If you're using the Ruby Gem version of the theme upgrading is fairly painless.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Configuration"
|
||||
permalink: /docs/configuration/
|
||||
excerpt: "Settings for configuring and customizing the theme."
|
||||
modified: 2016-11-29T08:44:22-05:00
|
||||
last_modified_at: 2016-11-29T08:44:22-05:00
|
||||
---
|
||||
|
||||
Settings that affect your entire site can be changed in [Jekyll's configuration file](https://jekyllrb.com/docs/configuration/): `_config.yml`, found in the root of your project. If you don't have this file you'll need to copy or create one using the theme's [default `_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml) as a base.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Overriding Theme Defaults"
|
||||
permalink: /docs/overriding-theme-defaults/
|
||||
excerpt: "Instructions on how to customize the theme's default set of layouts, includes, and stylesheets when using the Ruby Gem version."
|
||||
modified: 2016-11-03T10:49:48-04:00
|
||||
last_modified_at: 2016-11-03T10:49:48-04:00
|
||||
---
|
||||
|
||||
When installing the theme as a Ruby Gem its layouts, includes, stylesheets, and other assets are all bundled in the `gem`. Meaning they're not easily visible in your project.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Navigation"
|
||||
permalink: /docs/navigation/
|
||||
excerpt: "Instructions on how to customize the main navigation and enabling breadcrumb links."
|
||||
modified: 2016-11-03T10:50:03-04:00
|
||||
last_modified_at: 2016-11-03T10:50:03-04:00
|
||||
---
|
||||
|
||||
## Masthead
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "UI Text"
|
||||
permalink: /docs/ui-text/
|
||||
excerpt: "Text for customizing various user interface elements found in the theme."
|
||||
modified: 2017-02-14T14:13:24-05:00
|
||||
last_modified_at: 2017-02-14T14:13:24-05:00
|
||||
---
|
||||
|
||||
Text for various UI elements, `_layouts`, and `_includes` have all been grouped together as a set of translation keys. This is by no means a full-on i18n solution, but it does help make customizing things a bit easier.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Authors"
|
||||
permalink: /docs/authors/
|
||||
excerpt: "Instructions and settings for working with multiple site authors."
|
||||
modified: 2016-11-03T10:55:15-04:00
|
||||
last_modified_at: 2016-11-03T10:55:15-04:00
|
||||
---
|
||||
|
||||
Sites that may have content authored from various individuals can be accommodated by using [data files](https://jekyllrb.com/docs/datafiles/).
|
||||
|
||||
@@ -7,7 +7,7 @@ single_layout_gallery:
|
||||
alt: "single layout with header example"
|
||||
- image_path: /assets/images/mm-layout-single-meta.png
|
||||
alt: "single layout with comments and related posts"
|
||||
modified: 2017-02-24T15:23:34-05:00
|
||||
last_modified_at: 2017-02-24T15:23:34-05:00
|
||||
---
|
||||
|
||||
{% include toc icon="columns" title="Included Layouts" %}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Working with Posts"
|
||||
permalink: /docs/posts/
|
||||
excerpt: "Suggestions and Front Matter defaults for working with posts."
|
||||
modified: 2016-11-03T11:12:40-04:00
|
||||
last_modified_at: 2016-11-03T11:12:40-04:00
|
||||
---
|
||||
|
||||
Posts are stored in the `_posts` directory and named according to the `YEAR-MONTH-DAY-title.MARKUP` format as per [the usual](https://jekyllrb.com/docs/posts/).
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Working with Pages"
|
||||
permalink: /docs/pages/
|
||||
excerpt: "Suggestions and Front Matter defaults for working with pages."
|
||||
modified: 2016-11-03T11:13:12-04:00
|
||||
last_modified_at: 2016-11-03T11:13:12-04:00
|
||||
---
|
||||
|
||||
To better organize all of your pages you can centralize them into a single location similar to posts and collections.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Working with Collections"
|
||||
permalink: /docs/collections/
|
||||
excerpt: "Suggestions and Front Matter defaults for working with collections."
|
||||
modified: 2016-11-03T11:13:38-04:00
|
||||
last_modified_at: 2016-11-03T11:13:38-04:00
|
||||
---
|
||||
|
||||
Collections like posts and pages work as you'd expect. If you're new to them be sure to read [Jekyll's documentation](https://jekyllrb.com/docs/collections/).
|
||||
|
||||
@@ -30,7 +30,7 @@ feature_row:
|
||||
- image_path: /assets/images/unsplash-gallery-image-3-th.jpg
|
||||
title: "Placeholder 3"
|
||||
excerpt: "This is some sample content that goes here with **Markdown** formatting."
|
||||
modified: 2016-11-15T12:11:48-05:00
|
||||
last_modified_at: 2016-11-15T12:11:48-05:00
|
||||
---
|
||||
|
||||
{% include toc icon="gears" title="Helpers" %}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Utility Classes"
|
||||
permalink: /docs/utility-classes/
|
||||
excerpt: "CSS classes for aligning text/image, styling buttons and notices, and more."
|
||||
modified: 2016-11-03T11:32:25-04:00
|
||||
last_modified_at: 2016-11-03T11:32:25-04:00
|
||||
---
|
||||
|
||||
{% include toc icon="gears" title="Utility Classes" %}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Stylesheets"
|
||||
permalink: /docs/stylesheets/
|
||||
excerpt: "Instructions for customizing and building the theme's stylesheets."
|
||||
modified: 2016-11-03T11:34:42-04:00
|
||||
last_modified_at: 2016-11-03T11:34:42-04:00
|
||||
---
|
||||
|
||||
The theme's `assets/css/main.css` file is built from several SCSS partials located in [`_sass/`](https://github.com/mmistakes/minimal-mistakes/tree/master/_sass) and is structured as follows:
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "JavaScript"
|
||||
permalink: /docs/javascript/
|
||||
excerpt: "Instructions for customizing and building the theme's scripts."
|
||||
modified: 2016-11-03T11:35:42-04:00
|
||||
last_modified_at: 2016-11-03T11:35:42-04:00
|
||||
---
|
||||
|
||||
The theme's [`assets/js/main.min.js`] script is built from several vendor, jQuery plugins, and other scripts found in [`assets/js/`](https://github.com/mmistakes/minimal-mistakes/tree/master/assets/js).
|
||||
|
||||
@@ -4,7 +4,7 @@ permalink: /docs/history/
|
||||
excerpt: "Change log of enhancements and bug fixes made to the theme."
|
||||
sidebar:
|
||||
nav: docs
|
||||
modified: 2017-03-27T08:24:24-04:00
|
||||
last_modified_at: 2017-03-27T08:24:24-04:00
|
||||
---
|
||||
|
||||
## Unreleased
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "Contributing"
|
||||
permalink: /docs/contributing/
|
||||
excerpt: "How you can contribute to make this theme better."
|
||||
modified: 2017-03-22T09:51:05-04:00
|
||||
last_modified_at: 2017-03-22T09:51:05-04:00
|
||||
---
|
||||
|
||||
Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature or [fixing a bug](https://github.com/mmistakes/minimal-mistakes/issues)? Then by all means [submit an issue](https://github.com/mmistakes/minimal-mistakes/issues/new) or [pull request](https://help.github.com/articles/using-pull-requests/). If this is your first pull request, it may be helpful to read up on the [GitHub Flow](https://guides.github.com/introduction/flow/) first.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "2.2 Documentation"
|
||||
permalink: /docs/docs-2-2/
|
||||
excerpt: "Setup and installation instructions for Minimal Mistakes 2.2 (deprecated)."
|
||||
modified: 2016-04-13T15:54:02-04:00
|
||||
last_modified_at: 2016-04-13T15:54:02-04:00
|
||||
---
|
||||
|
||||
{% include toc %}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
title: "License"
|
||||
permalink: /docs/license/
|
||||
excerpt: "License for Minimal Mistakes Jekyll Theme."
|
||||
modified: 2016-04-13T15:05:12-04:00
|
||||
last_modified_at: 2016-04-13T15:05:12-04:00
|
||||
---
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Reference in New Issue
Block a user