You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Move gh-pages branch files into /docs and add test files
- Jekyll ignore `/docs` and `/test` folders when using from root
- Update Staticman config to point to correct branch and data file location
- Replace `{{ base_path }}` references with `absolute_url` filter
- Update documentation
Copy file name to clipboardexpand all lines: README.md
+11-9
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ See what's new in the [CHANGELOG](CHANGELOG.md).
25
25
- 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.
26
26
- 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](https://staticman.net/), and custom).
- UI localized text in English (default), Brazilian Portguese, Chinese, French, German, Italian, Spanish, and Turkish
28
+
- UI localized text in English (default), Brazilian Portuguese, Chinese, French, German, Italian, Spanish, and Turkish
29
29
30
30
## Demo Pages
31
31
@@ -39,7 +39,7 @@ See what's new in the [CHANGELOG](CHANGELOG.md).
39
39
|[Categories Archive][categories-archive]| Posts grouped by category. |
40
40
|[Tags Archive][tags-archive]| Posts grouped by tags. |
41
41
42
-
For even more demo pages check the [posts archive][year-archive] on the demo site. Looking for the source code to peep the YAML Front Matter and Markdown used? Check the [`gh-pages`](https://github.com/mmistakes/minimal-mistakes/tree/gh-pages) branch.
42
+
Additional sample posts are available under [posts archive][year-archive] on the demo site. Source files for these (and the entire demo site) can be found in [`/docs`](docs).
For detailed instructions on how to configure, customize, add content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).
56
+
57
+
**Note:** Gem version of the theme requires Jekyll v3.3+ and is not currently supported on [GitHub Pages](https://pages.github.com/). You can still use the theme with GitHub Pages, you'll just need to install using the old "[repo fork method](https://mmistakes.github.io/minimal-mistakes/docs/installation/)".
58
+
53
59
## Quick Start
54
60
55
61
Add this line to your Jekyll site's `Gemfile`:
@@ -64,17 +70,13 @@ Add this line to your Jekyll site's `_config.yml` file:
64
70
theme: minimal-mistakes-jekyll
65
71
```
66
72
67
-
Run Bundler:
73
+
Then run Bundler to install the theme gem and dependencies:
68
74
69
75
```bash
70
76
bundle install
71
77
```
72
78
73
-
## Usage
74
-
75
-
For detailed instructions on how to configure, customize, add content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).
76
-
77
-
**Note:** Gem version of the theme requires Jekyll v3.3+ and is not supported with sites hosted with [GitHub Pages](https://pages.github.com/). You can still use the theme on GitHub Pages, you'll just need to install using the old "[repo fork method](https://mmistakes.github.io/minimal-mistakes/docs/installation/)".
79
+
To update the theme run `bundle update`.
78
80
79
81
---
80
82
@@ -90,7 +92,7 @@ This goes for author sidebar links and "share button" additions -- I have no int
90
92
91
93
To help me out try to avoid creating pull requests on `master` and instead branch off of `develop`. It's much easier for me to test, merge, and roll them into new releases this way.
92
94
93
-
Theme documentation and demo pages can be found in the `gh-pages` branch, please submit pull requests against that branch.
95
+
Theme documentation and demo pages can be found in the [`/docs`](docs) if submitting improvements, typo corrections, etc.
0 commit comments