Skip to content

Commit 3dde1cc

Browse files
committed
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
1 parent 33316e3 commit 3dde1cc

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
- Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226)
66
- 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)
7+
- Add note about Staticman GitHub compatibility. [#1273](https://github.com/mmistakes/minimal-mistakes/issues/1273)
78

89
## [4.6.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.6.0)
910

docs/_docs/05-configuration.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Configuration"
33
permalink: /docs/configuration/
44
excerpt: "Settings for configuring and customizing the theme."
5-
last_modified_at: 2017-09-12T12:25:16-04:00
5+
last_modified_at: 2017-09-25T09:17:57-04:00
66
---
77

88
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
317317

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

320+
**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.
321+
{: .notice--warning}
322+
320323
**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.
321324
{: .notice--info}
322325

docs/_docs/18-history.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ permalink: /docs/history/
44
excerpt: "Change log of enhancements and bug fixes made to the theme."
55
sidebar:
66
nav: docs
7-
last_modified_at: 2017-09-21T16:17:50-04:00
7+
last_modified_at: 2017-09-25T09:18:47-04:00
88
---
99

1010
## Unreleased
@@ -13,6 +13,7 @@ last_modified_at: 2017-09-21T16:17:50-04:00
1313

1414
- Add `alt` description to avatar image. [#1226](https://github.com/mmistakes/minimal-mistakes/pull/1226)
1515
- 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)
16+
- Add note about Staticman GitHub compatibility. [#1273](https://github.com/mmistakes/minimal-mistakes/issues/1273)
1617

1718
## [4.6.0](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.6.0)
1819

0 commit comments

Comments
 (0)