update config to be more clear about staticman params

This commit is contained in:
Dean Attali 2020-07-13 01:12:03 -04:00 committed by GitHub
parent 68a0e505bf
commit 58835f4098
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -140,14 +140,14 @@ footer-link-col: "#404040"
# To use Staticman comments, first invite `staticmanlab` as a collaborator to your repository and # To use Staticman comments, first invite `staticmanlab` as a collaborator to your repository and
# accept the invitation by going to `https://staticman3.herokuapp.com/v3/connect/github/<username>/<repo-name>`. # accept the invitation by going to `https://staticman3.herokuapp.com/v3/connect/github/<username>/<repo-name>`.
# Then uncomment the following section and fill in "repository", "branch", and "endpoint". # Then uncomment the following section and fill in "repository" and "branch".
# If you want to use reCaptcha for staticman (optional for spam protection), then fill # If you want to use reCaptcha for staticman (optional for spam protection), then fill
# in the "siteKey" and "secret" parameters below and also in `staticman.yml`. # in the "siteKey" and "secret" parameters below and also in `staticman.yml`.
# See more details at https://staticman.net/ # See more details at https://staticman.net/
#staticman: #staticman:
# repository : # GitHub username/repository eg. "daattali/beautiful-jekyll" # repository : # GitHub username/repository eg. "daattali/beautiful-jekyll"
# branch : master # If you're not using `master` branch, then you also need to update the `branch` parameter in `staticman.yml` # branch : master # If you're not using `master` branch, then you also need to update the `branch` parameter in `staticman.yml`
# endpoint : # URL of your own deployment, with a trailing slash (will fallback to a public GitLab instance) eg. https://<your-api>/v3/entry/github/ # endpoint : # (optional) URL of your own deployment, with a trailing slash eg. https://<your-api>/v3/entry/github/ (will fallback to a public GitLab instance)
# reCaptcha: # reCaptcha:
# siteKey : # Use your own site key, you need to apply for one on Google # siteKey : # Use your own site key, you need to apply for one on Google
# secret : # ENCRYPT your password by going to https://staticman3.herokuapp.com/v3/encrypt/<your-site-secret> # secret : # ENCRYPT your password by going to https://staticman3.herokuapp.com/v3/encrypt/<your-site-secret>