mirror of
https://github.com/hacks-guide/minimal-mistakes.git
synced 2024-11-26 18:30:28 +00:00
Add search layout documentation
This commit is contained in:
Michael Rose
parent
cc3b21bc86
commit
2a5cda62b1
@ -2,6 +2,7 @@
|
||||
|
||||
### Enhancements
|
||||
|
||||
- Add search layout powered by [Lunr](https://lunrjs.com/). [#1353](https://github.com/mmistakes/minimal-mistakes/pull/1353)
|
||||
- Use [jekyll-remote-theme](https://github.com/benbalter/jekyll-remote-theme) for demo site. [#1339](https://github.com/mmistakes/minimal-mistakes/issues/1339)
|
||||
- Add note about WordPress to Staticman comment migration tool in documentation. [#1346](https://github.com/mmistakes/minimal-mistakes/issues/1346)
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your
|
||||
- Compatible with GitHub Pages.
|
||||
- Support for Jekyll's built-in Sass/SCSS preprocessor.
|
||||
- Nine different skins (color variations).
|
||||
- Several responsive layout options (single, archive index, splash, and paginated home page).
|
||||
- Several responsive layout options (single, archive index, search, splash, and paginated home page).
|
||||
- Optimized for search engines with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data
|
||||
- Optional [header images](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#headers), [custom sidebars](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#sidebars), [table of contents](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#table-of-contents), [galleries](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#gallery), related posts, [breadcrumb links](https://mmistakes.github.io/minimal-mistakes/docs/configuration/#breadcrumb-navigation-beta), [navigation lists](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#navigation-list), and more.
|
||||
- Commenting support (powered by [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman v1 and v2](https://staticman.net/), and custom).
|
||||
|
||||
@ -33,6 +33,7 @@ minimal-mistakes
|
||||
| ├── compress.html # compresses HTML in pure Liquid
|
||||
| ├── default.html # base for all other layouts
|
||||
| ├── home.html # home page
|
||||
| ├── search.html # search page
|
||||
| ├── single.html # single document (post/page/etc)
|
||||
| └── splash.html # splash page
|
||||
├── _sass # SCSS partials
|
||||
|
||||
@ -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"
|
||||
last_modified_at: 2017-11-13T18:37:30-05:00
|
||||
last_modified_at: 2017-11-15T15:01:40-05:00
|
||||
toc: true
|
||||
toc_label: "Included Layouts"
|
||||
toc_icon: "columns"
|
||||
@ -36,6 +36,7 @@ Class names corresponding to each layout are automatically added to the `<body>`
|
||||
| ---------------- | --------------------------- |
|
||||
| archive | `.layout--archive` |
|
||||
| archive-taxonomy | `.layout--archive-taxonomy` |
|
||||
| search | `.layout--search` |
|
||||
| single | `.layout--single` |
|
||||
| splash | `.layout--splash` |
|
||||
| home | `.layout--home` |
|
||||
@ -217,7 +218,7 @@ author_profile: true
|
||||
{% endfor %}{% endraw %}
|
||||
```
|
||||
|
||||
### Home Page
|
||||
## Home Page Layout
|
||||
|
||||
A derivative archive page layout to be used as a simple home page. It is built to show a paginated list of recent posts based off of the [pagination settings]({{ "/docs/configuration/#paginate" | absolute_url }}) in `_config.yml`.
|
||||
|
||||
@ -268,6 +269,14 @@ For full-width landing pages that need a little something extra add `layout: spl
|
||||
|
||||
Feature blocks can be assigned and aligned to the `left`, `right`, or `center` with a sprinkling of YAML. For full details on how to use the `feature_row` helper check the [**Content**]({{ "/docs/helpers/" | absolute_url }}) section or review a [sample splash page](https://github.com/{{ site.repository }}/blob/master/docs/_pages/splash-page.md).
|
||||
|
||||
## Search Page Layout
|
||||
|
||||
A page with a search form. Add `layout: search` to the YAML Front Matter similar to [this example](https://github.com/mmistakes/minimal-mistakes/blob/master/docs/_pages/search.md) on the demo site.
|
||||
|
||||
![search page layout example]({{ "/assets/images/search-layout-example.png" | absolute_url }})
|
||||
|
||||
**ProTip:** Add a link to this page in the masthead navigation.
|
||||
{: .notice--info}
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ permalink: /docs/history/
|
||||
excerpt: "Change log of enhancements and bug fixes made to the theme."
|
||||
sidebar:
|
||||
nav: docs
|
||||
last_modified_at: 2017-11-13T18:52:34-05:00
|
||||
last_modified_at: 2017-11-15T14:49:12-05:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
@ -12,6 +12,7 @@ toc: true
|
||||
|
||||
### Enhancements
|
||||
|
||||
- Add search layout powered by [Lunr](https://lunrjs.com/). [#1353](https://github.com/mmistakes/minimal-mistakes/pull/1353)
|
||||
- Use [jekyll-remote-theme](https://github.com/benbalter/jekyll-remote-theme) for demo site. [#1339](https://github.com/mmistakes/minimal-mistakes/issues/1339)
|
||||
- Add note about WordPress to Staticman comment migration tool in documentation. [#1346](https://github.com/mmistakes/minimal-mistakes/issues/1346)
|
||||
|
||||
|
||||
@ -28,7 +28,7 @@ Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your
|
||||
- Compatible with GitHub Pages.
|
||||
- Support for Jekyll's built-in Sass/SCSS preprocessor.
|
||||
- Nine different skins (color variations).
|
||||
- Several responsive layout options (single, archive index, splash, and paginated home page).
|
||||
- Several responsive layout options (single, archive index, search, splash, and paginated home page).
|
||||
- Optimized for search engines with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data
|
||||
- Optional [header images](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#headers), [custom sidebars](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#sidebars), [table of contents](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#table-of-contents), [galleries](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#gallery), related posts, [breadcrumb links](https://mmistakes.github.io/minimal-mistakes/docs/configuration/#breadcrumb-navigation-beta), [navigation lists](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#navigation-list), and more.
|
||||
- Commenting support (powered by [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman v1 and v2](https://staticman.net/), and custom).
|
||||
|
||||
BIN
docs/assets/images/search-layout-example.png
Normal file
BIN
docs/assets/images/search-layout-example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
Loading…
Reference in New Issue
Block a user