Skip to content

Commit 57a4324

Browse files
committedNov 3, 2016
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
1 parent 8ed9786 commit 57a4324

File tree

570 files changed

+22895
-84
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

570 files changed

+22895
-84
lines changed
 

‎README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ See what's new in the [CHANGELOG](CHANGELOG.md).
2525
- 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.
2626
- 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).
2727
- [Google Analytics](https://www.google.com/analytics/) support.
28-
- 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
2929

3030
## Demo Pages
3131

@@ -39,7 +39,7 @@ See what's new in the [CHANGELOG](CHANGELOG.md).
3939
| [Categories Archive][categories-archive] | Posts grouped by category. |
4040
| [Tags Archive][tags-archive] | Posts grouped by tags. |
4141

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).
4343

4444
[header-image-post]: https://mmistakes.github.io/minimal-mistakes/layout-header-image-text-readability/
4545
[gallery-post]: https://mmistakes.github.io/minimal-mistakes/post%20formats/post-gallery/
@@ -50,6 +50,12 @@ For even more demo pages check the [posts archive][year-archive] on the demo sit
5050
[tags-archive]: https://mmistakes.github.io/minimal-mistakes/tags/
5151
[year-archive]: https://mmistakes.github.io/minimal-mistakes/year-archive/
5252

53+
## Usage
54+
55+
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+
5359
## Quick Start
5460

5561
Add this line to your Jekyll site's `Gemfile`:
@@ -64,17 +70,13 @@ Add this line to your Jekyll site's `_config.yml` file:
6470
theme: minimal-mistakes-jekyll
6571
```
6672
67-
Run Bundler:
73+
Then run Bundler to install the theme gem and dependencies:
6874
6975
```bash
7076
bundle install
7177
```
7278

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`.
7880

7981
---
8082

@@ -90,7 +92,7 @@ This goes for author sidebar links and "share button" additions -- I have no int
9092

9193
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.
9294

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.
9496

9597
---
9698

‎_config.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ comments:
3030
colorscheme : # "light" (default), "dark"
3131
staticman:
3232
allowedFields : ['name', 'email', 'url', 'message']
33-
branch : # "master", "gh-pages"
33+
branch : "master"
3434
commitMessage : "New comment."
3535
filename : comment-{@timestamp}
3636
format : "yml"
3737
moderation : true
38-
path : "_data/comments/{options.slug}"
38+
path : "docs/_data/comments/{options.slug}"
3939
requiredFields : ['name', 'email', 'message']
4040
transforms:
4141
email : "md5"
@@ -135,6 +135,8 @@ exclude:
135135
- Rakefile
136136
- README
137137
- tmp
138+
- /docs # ignore Minimal Mistakes /docs
139+
- /test # ignore Minimal Mistakes /test
138140
keep_files:
139141
- .git
140142
- .svn

0 commit comments

Comments
 (0)
Please sign in to comment.