Skip to content

Commit

Permalink
Move gh-pages branch files into /docs and add test files
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
mmistakes committed Nov 3, 2016
1 parent 8ed9786 commit 57a4324
Show file tree
Hide file tree
Showing 570 changed files with 22,895 additions and 84 deletions.
20 changes: 11 additions & 9 deletions README.md
Expand Up @@ -25,7 +25,7 @@ See what's new in the [CHANGELOG](CHANGELOG.md).
- 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](https://staticman.net/), and custom).
- [Google Analytics](https://www.google.com/analytics/) support.
- UI localized text in English (default), Brazilian Portguese, Chinese, French, German, Italian, Spanish, and Turkish
- UI localized text in English (default), Brazilian Portuguese, Chinese, French, German, Italian, Spanish, and Turkish

## Demo Pages

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

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

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

## Usage

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

**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/)".

## Quick Start

Add this line to your Jekyll site's `Gemfile`:
Expand All @@ -64,17 +70,13 @@ Add this line to your Jekyll site's `_config.yml` file:
theme: minimal-mistakes-jekyll
```

Run Bundler:
Then run Bundler to install the theme gem and dependencies:

```bash
bundle install
```

## Usage

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

**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/)".
To update the theme run `bundle update`.

---

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

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.

Theme documentation and demo pages can be found in the `gh-pages` branch, please submit pull requests against that branch.
Theme documentation and demo pages can be found in the [`/docs`](docs) if submitting improvements, typo corrections, etc.

---

Expand Down
6 changes: 4 additions & 2 deletions _config.yml
Expand Up @@ -30,12 +30,12 @@ comments:
colorscheme : # "light" (default), "dark"
staticman:
allowedFields : ['name', 'email', 'url', 'message']
branch : # "master", "gh-pages"
branch : "master"
commitMessage : "New comment."
filename : comment-{@timestamp}
format : "yml"
moderation : true
path : "_data/comments/{options.slug}"
path : "docs/_data/comments/{options.slug}"
requiredFields : ['name', 'email', 'message']
transforms:
email : "md5"
Expand Down Expand Up @@ -135,6 +135,8 @@ exclude:
- Rakefile
- README
- tmp
- /docs # ignore Minimal Mistakes /docs
- /test # ignore Minimal Mistakes /test
keep_files:
- .git
- .svn
Expand Down
18 changes: 9 additions & 9 deletions _data/navigation.yml
@@ -1,12 +1,12 @@
# main links links
# main links
main:
- title: "Quick-Start Guide"
url: https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/
- title: "About"
url: https://mmistakes.github.io/minimal-mistakes/about/
- title: "Sample Posts"
url: /year-archive/
- title: "Sample Collections"
url: /collection-archive/
- title: "Sitemap"
url: /sitemap/
# - title: "About"
# url: https://mmistakes.github.io/minimal-mistakes/about/
# - title: "Sample Posts"
# url: /year-archive/
# - title: "Sample Collections"
# url: /collection-archive/
# - title: "Sitemap"
# url: /sitemap/
14 changes: 14 additions & 0 deletions docs/Gemfile
@@ -0,0 +1,14 @@
source "https://rubygems.org"

gem "github-pages", group: :jekyll_plugins

gem "wdm", "~> 0.1.0" if Gem.win_platform?

# If you have any plugins, put them here!
# group :jekyll_plugins do
# gem "jekyll-paginate"
# gem "jekyll-sitemap"
# gem "jekyll-gist"
# gem "jekyll-feed"
# gem "jemoji"
# end
13 changes: 13 additions & 0 deletions docs/_config.dev.yml
@@ -0,0 +1,13 @@
# Develop override settings

url: http://localhost:4000

analytics:
provider: false

comments:
disqus:
shortname : "mmistakes-dev"

sass:
style: expanded

0 comments on commit 57a4324

Please sign in to comment.