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.

Sign up for GitHub

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

Jump to bottom

Staticman documentation enhancement #514

Merged
merged 9 commits into from
Jul 8, 2019
Merged

Staticman documentation enhancement #514

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
976ee46
Add a link to Staticman: Webhooks
VincentTam Jul 3, 2019
078eb19
Clearer README on Staticman reCAPTCHA and endpoint
VincentTam Jul 3, 2019
df3ea4b
Update README after owner's feedback
VincentTam Jul 4, 2019
1d1833f
Update staticman.yml after owner's feedback
VincentTam Jul 4, 2019
81b35c5
Further improve Staticman templates
VincentTam Jul 5, 2019
c24f94e
Corrected Staticman config instructions
VincentTam Jul 8, 2019
6a6c4db
Update staticman.yml
daattali Jul 8, 2019
b3be878
Update _config.yml
daattali Jul 8, 2019
97900d4
Update README.md
daattali Jul 8, 2019
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ To use Staticman, you first need to invite `staticmanlab` as a collaborator to y

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`.

#### JustComments

To use JustComments you first need to have an account. After you just need to copy the API key to the `just-comments` property in `_config.yml` file.
Expand Down
4 changes: 2 additions & 2 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ url-pretty: "MyWebsite.com" # eg. "deanattali.com/beautiful-jekyll"
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`
endpoint : # URL of your own deployment (with trailing slash) (will fallback to a public GitLab instance)
endpoint : # URL of your own deployment (with trailing slash) (will fallback to a public GitLab instance) eg. https://<your-api>/v3/entry/github/
reCaptcha:
# reCaptcha for Staticman (OPTIONAL)
# reCaptcha for Staticman (OPTIONAL, but recommended for spam protection)
# If you use reCaptcha, you must also set these parameters in staticman.yml
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>
Expand Down
4 changes: 2 additions & 2 deletions staticman.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=="