steffen/website
1
0
Fork 0
Code Actions Packages Releases Activity

Add note about Staticman GitHub compatibility

Browse Source 
Staticman only works with GitHub hosted repositories. This enhancement to the theme's documentation makes that clear.

Close #1273
This commit is contained in:
Michael Rose
2017-09-25 09:19:55 -04:00
parent 33316e3d25
commit 3dde1cc729
3 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/_docs/05-configuration.md
View File

@@ -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}