From 3dde1cc7299d999df64e4ddfb2b9bf97caddc41d Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Mon, 25 Sep 2017 09:19:55 -0400 Subject: [PATCH] Add note about Staticman GitHub compatibility Staticman only works with GitHub hosted repositories. This enhancement to the theme's documentation makes that clear. Close #1273 --- CHANGELOG.md | 1 + docs/_docs/05-configuration.md | 5 ++++- docs/_docs/18-history.md | 3 ++- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 496b9ea1..1f21e8eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ - Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226) - Clarify documentation about which `assets` folders and files to remove when migrating to the gem version of the theme. [#1268](https://github.com/mmistakes/minimal-mistakes/issues/1268) +- Add note about Staticman GitHub compatibility. [#1273](https://github.com/mmistakes/minimal-mistakes/issues/1273) ## [4.6.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.6.0) diff --git a/docs/_docs/05-configuration.md b/docs/_docs/05-configuration.md index 44d1d3f5..23c2a517 100644 --- a/docs/_docs/05-configuration.md +++ b/docs/_docs/05-configuration.md @@ -2,7 +2,7 @@ title: "Configuration" permalink: /docs/configuration/ excerpt: "Settings for configuring and customizing the theme." -last_modified_at: 2017-09-12T12:25:16-04:00 +last_modified_at: 2017-09-25T09:17:57-04:00 --- Settings that affect your entire site can be changed in [Jekyll's configuration file](https://jekyllrb.com/docs/configuration/): `_config.yml`, found in the root of your project. If you don't have this file you'll need to copy or create one using the theme's [default `_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml) as a base. @@ -317,6 +317,9 @@ Transform user comments into `_data` files that live inside of your GitHub repos Default settings have been provided in `_config.yml`. The important ones to set are `provider: "staticman"`, `branch`, and `path`. View the [full list of configurations](https://github.com/eduardoboucas/staticman#jekyll-configuration). +**Note:** Staticman is currently only compatible with GitHub based repositories. [Support for GitLab Pages](https://github.com/eduardoboucas/staticman/issues/22) is planned but not available yet. +{: .notice--warning} + **Branch setting:** This is the branch comment files will be sent to via pull requests. If you host your site on GitHub Pages it will likely be `master` unless your repo is setup as a project --- use `gh-pages` in that case. {: .notice--info} diff --git a/docs/_docs/18-history.md b/docs/_docs/18-history.md index e7533815..1eafbd75 100644 --- a/docs/_docs/18-history.md +++ b/docs/_docs/18-history.md @@ -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-09-21T16:17:50-04:00 +last_modified_at: 2017-09-25T09:18:47-04:00 --- ## Unreleased @@ -13,6 +13,7 @@ last_modified_at: 2017-09-21T16:17:50-04:00 - Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226) - Clarify documentation about which `assets` folders and files to remove when migrating to the gem version of the theme. [#1268](https://github.com/mmistakes/minimal-mistakes/issues/1268) +- Add note about Staticman GitHub compatibility. [#1273](https://github.com/mmistakes/minimal-mistakes/issues/1273) ## [4.6.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.6.0)