Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Staticman documentation enhancement #514

Merged
merged 9 commits into from
Jul 8, 2019
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Further improve Staticman templates
VincentTam committed Jul 5, 2019
commit 81b35c5470e36571ca5c2191933ff300b2ed2899
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -118,6 +118,8 @@ To use Facebook comments, create a Facebook app using [Facebook developers](http

To use Staticman, you first need to invite `staticmanlab` as a collaborator to your repository (by going to your repository **Settings** page, navigate to the **Collaborators** tab, and add the username `staticmanlab`), and then accept the invitation by going to `https://staticman3.herokuapp.com/v3/connect/github/<username>/<repo-name>`. Lastly, fill in your `repository` and `branch` in the Staticman section of `_config.yml`.

Notes: You may choose other Staticman API instance. In this case, adjust the collaborator, the above invitation link and `endpoint` in the Staticman section of `_config.yml` accordingly. In addition, the parameters `<username>` and `<repo-name>` are case-sensitive.

Optional: It is suggested to enable reCAPTCHA to avoid massive spam comments. You may refer to `_config.yml` for detailed instructions.

Optional: You might want to configure a webhook to prevent inactive branches representing merged comments from stacking up. You may refer to [Staticman's documenation](https://staticman.net/docs/webhooks) for details. Please input the **Payload URL** according to your chosen `endpoint`. For example, the default `endpoint` is `https://staticman3.herokuapp.com/v3/entry/github/`, so the corresponding **Payload URL** should be `https://staticman3.herokuapp.com/v1/webhook`.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -126,7 +126,7 @@ url-pretty: "MyWebsite.com" # eg. "deanattali.com/beautiful-jekyll"
# To use Facebook Comments, fill in a Facebook App ID
# fb_comment_id: ""

# Staticman support
# Staticman support (parameters under this section are CASE-sensitive)
staticman:
repository : # GitHub username/repository eg. "daattali/beautiful-jekyll"
branch : # eg. "master" If you're not using `master` branch, then you also need to update the `branch` parameter in `staticman.yml`
4 changes: 2 additions & 2 deletions staticman.yml
Original file line number Diff line number Diff line change
@@ -101,8 +101,8 @@ comments:
# Use your OWN siteKey and secret.
reCaptcha:
enabled: false
# siteKey: "6Lcv8G8UAAAAAEqV1Y-XEPum00C_DxhD6O--qkFo"
#siteKey: "6Lcv8G8UAAAAAEqV1Y-XEPum00C_DxhD6O--qkFo"
# (!) ENCRYPT reCaptcha secret key using Staticman /encrypt endpoint
# i.e. https://staticman3.herokuapp.com/v3/encrypt/{your-site-secret}
# For more information, https://staticman.net/docs/encryption
# secret: "p5uHlH9hCqpMJaGKXdt5MEWFo7K6fX8hoYUwR3aIafOI6rtItLauaDCkGOucysJtrVZy+sHffioGzMsOU64JFDSyPQgrXujegcOHFRXHhD4fOUuBXSvV+OZ8JhSPTGWaRcQcoiGX4pT5hlebLddOl59b6sn6kU1ODQcEbhP83xVLZlaTWOrNrF5Wvy3TMXpH5gyl1tZEORxADAShMYyUbNR7XZYLEg1DfgIBHfIg3cKwdFt7KVLejFGKIiBYRAZDE2JuHItNmzJ2x9JgSK3E+XnShV5tuWpncnyFonJVHGEky/zRfUVLHobDMcJ/u9nlZqE8u47W+833F1WaIYuwNw=="
#secret: "p5uHlH9hCqpMJaGKXdt5MEWFo7K6fX8hoYUwR3aIafOI6rtItLauaDCkGOucysJtrVZy+sHffioGzMsOU64JFDSyPQgrXujegcOHFRXHhD4fOUuBXSvV+OZ8JhSPTGWaRcQcoiGX4pT5hlebLddOl59b6sn6kU1ODQcEbhP83xVLZlaTWOrNrF5Wvy3TMXpH5gyl1tZEORxADAShMYyUbNR7XZYLEg1DfgIBHfIg3cKwdFt7KVLejFGKIiBYRAZDE2JuHItNmzJ2x9JgSK3E+XnShV5tuWpncnyFonJVHGEky/zRfUVLHobDMcJ/u9nlZqE8u47W+833F1WaIYuwNw=="