Update docs
This commit is contained in:
Michael Rose
parent
5ae39ef82c
commit
1dbc92d08c
|
|
@ -30,6 +30,9 @@ If you're hosting several Jekyll based sites under the same GitHub username you
|
|||
<img src="{{ base_path }}/images/mm-gh-pages.gif" alt="creating a new branch on GitHub">
|
||||
</figure>
|
||||
|
||||
**ProTip:** Be sure to [delete](https://github.com/blog/1377-create-and-delete-branches) the `gh-pages` branch if you forked Minimal Mistakes. This branch contains the documentation and demo site for the theme and you probably don't want that showing up in your repo.
|
||||
{: .notice--info}
|
||||
|
||||
## 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.
|
||||
|
|
|
|||
|
|
@ -26,6 +26,9 @@ There are several ways to install the theme:
|
|||
|
||||
[<i class="fa fa-download"></i> Download Minimal Mistakes Theme](https://github.com/mmistakes/minimal-mistakes/archive/master.zip){: .btn .btn--success}
|
||||
|
||||
**ProTip:** Be sure to [delete](https://github.com/blog/1377-create-and-delete-branches) the `gh-pages` branch if you forked Minimal Mistakes. This branch contains the documentation and demo site for the theme and you probably don't want that showing up in your repo.
|
||||
{: .notice--info}
|
||||
|
||||
---
|
||||
|
||||
To move over any existing content you'll want to copy the contents of your `_posts` folder to the new site. Along with any pages, collections, data files, images, or other assets.
|
||||
|
|
|
|||
|
|
@ -8,9 +8,105 @@ sidebar:
|
|||
---
|
||||
|
||||
{% include base_path %}
|
||||
{% include toc icon="columns" title="Included Layouts" %}
|
||||
|
||||
The bread and butter of any theme. Below you'll find the layouts included with Minimal Mistakes, what they look like and the type of content they've been built for.
|
||||
|
||||
## Default
|
||||
|
||||
The base layout all other layouts inherit from. There's not much to this layout apart from pulling in several `_includes`:
|
||||
|
||||
* `<head>` elements
|
||||
* masthead navigation links
|
||||
* {% raw %}`{{ content }}`{% endraw %}
|
||||
* page footer
|
||||
* scripts
|
||||
|
||||
**Note:** You won't ever assign this layout directly to a post or page. Instead all other layouts will build off of it by setting `layout: default` in their YAML Front Matter.
|
||||
{: .notice--warning}
|
||||
|
||||
## Compress
|
||||
|
||||
A Jekyll layout that compresses HTML in pure Liquid.
|
||||
|
||||
* [Documentation](http://jch.penibelst.de/)
|
||||
|
||||
## Single
|
||||
|
||||
The layout you'll likely use the most --- thin sidebar on the left, main content on the right.
|
||||
|
||||
To enable add `layout: single` or better yet apply as a [Front Matter default]({{ base_path }}/docs/configuration/#front-matter-defaults) in `_config.yml`.
|
||||
|
||||
### Header
|
||||
|
||||
To add some visual punch to a post or page, a large full-width header image can be included.
|
||||
|
||||
**Note:** Be sure to resize your header images. `~1280px` is a good medium if you aren't [responsively serving up images](http://alistapart.com/article/responsive-images-in-practice). Through the magic of CSS they will scale up or down to fill the container. If you go with something too small it will look like garbage when upscaled, and something too large will hurt performance.
|
||||
{: .notice--warning}
|
||||
|
||||
|
||||
|
||||
Place your images in the `/images/` folder and add the following YAML Front Matter:
|
||||
|
||||
```yaml
|
||||
header:
|
||||
image: image-filename.jpg
|
||||
```
|
||||
|
||||
For externally hosted images include the full image path instead of just the filename:
|
||||
|
||||
```yaml
|
||||
header:
|
||||
image: http://some-site.com/image.jpg
|
||||
```
|
||||
|
||||
To include a caption or attribution for the image:
|
||||
|
||||
```yaml
|
||||
header:
|
||||
image: unsplash-image-1.jpg
|
||||
caption: "Photo credit: [**Unsplash**](https://unsplash.com)"
|
||||
```
|
||||
|
||||
**ProTip:** Captions written in Markdown are supported, so feel free to add links, or style text. Just be sure to wrap it in quotes.
|
||||
{: .notice--info}
|
||||
|
||||
### Header Overlay
|
||||
|
||||
To overlay text on top of a header image you have a few more options:
|
||||
|
||||
* `overlay_image` --- header image you'd like to overlay. Same rules as `header.image` from above.
|
||||
* `excerpt` --- auto-generated page excerpt is added to the overlay text or can be overridden.
|
||||
* `cta_label` --- call to action button text label (default is `more_label` in UI Text data file)
|
||||
* `cta_url` --- call to action button URL
|
||||
|
||||
With this YAML Front Matter:
|
||||
|
||||
```yaml
|
||||
excerpt: "This post should display a **header with an overlay image**, if the theme supports it."
|
||||
header:
|
||||
overlay_image: unsplash-image-1.jpg
|
||||
caption: "Photo credit: [**Unsplash**](https://unsplash.com)"
|
||||
cta_label: "More Info"
|
||||
cta_url: "https://unsplash.com"
|
||||
```
|
||||
|
||||
You should get an header image overlaid with text and a call to action button.
|
||||
|
||||
|
||||
|
||||
You also have the option of specifying a solid background-color to use instead of an image.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
excerpt: "This post should display a **header with a solid background color**, if the theme supports it."
|
||||
header:
|
||||
overlay_color: "#333"
|
||||
```
|
||||
|
||||
### Custom Sidebar
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -27,8 +123,4 @@ sidebar:
|
|||
|
||||
## Splash Page
|
||||
|
||||
|
||||
|
||||
## Default
|
||||
|
||||
## Compress
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 48 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1 MiB After Width: | Height: | Size: 1.1 MiB |
BIN
images/mm-single-header-example.jpg
Normal file
BIN
images/mm-single-header-example.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 138 KiB |
BIN
images/mm-single-header-overlay-example.jpg
Normal file
BIN
images/mm-single-header-overlay-example.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 73 KiB |
BIN
images/mm-single-header-overlay-fill-example.jpg
Normal file
BIN
images/mm-single-header-overlay-fill-example.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 22 KiB |
Loading…
Reference in a new issue