[Feature] Staticman v3 Support (#440)

* Added Staicman support

* Corrected template for staticman.yml

* Edit for coherence with _includes/disqus.html

* Updated documentation for Staticman

* Updated License to give credits to Michale Rose

* Update LICENSE

* add more staticman details to readme

* Clearer instructions about reCAPTCHA in YML

* Nest reCAPTCHA param inside Staticman

* Prepend all css selectors with .staticman-comments

Edit suggested by theme owner to avoid CSS rules overriding.

* Add myself to the change log

* Update _config.yml
This commit is contained in:
Vincent Tam 2018-12-25 23:21:42 +01:00 committed by Dean Attali
parent 018bac4894
commit d1c8b2fee1
14 changed files with 976 additions and 4 deletions

View file

@ -104,13 +104,21 @@ Many personalization settings in `_config.yml`, such as setting your name and si
### Allowing users to leave comments
If you want to enable comments on your site, Beautiful Jekyll supports either the [Disqus](https://disqus.com/) comments plugin or [Facebook](https://developers.facebook.com/docs/plugins/comments) comments.
If you want to enable comments on your site, Beautiful Jekyll supports either the [Disqus](https://disqus.com/) comments plugin, [Facebook](https://developers.facebook.com/docs/plugins/comments) comments or [Staticman](https://staticman.net). If any of these are set in the configuration file, then all blog posts will have comments turned on by default. To turn off comments on a particular blog post, add `comments: false` to the YAML front matter. If you want to add comments on the bottom of a non-blog page, add `comments: true` to the YAML front matter.
#### Disqus comments
To use Disqus, simply sign up to [Disqus](https://disqus.com/) and add your Disqus shortname to the `disqus` parameter in the `_config.yml` file.
#### Facebook comments
To use Facebook comments, create a Facebook app using [Facebook developers](https://developers.facebook.com/docs/apps/register), and add the Facebook App ID to the `fb_comment_id` parameter in `_config.yml`.
If either `disqus` or `fb_comment_id` parameters are set in the configuration file, then all blog posts will have comments turned on by default. To turn off comments on a particular blog post, add `comments: false` to the YAML front matter. If you want to add comments on the bottom of a non-blog page, add `comments: true` to the YAML front matter.
#### Staticman comments
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 `_config.yml`. If you're not using `master` branch, then you also need to update the `branch` parameter in `staticman.yml`.
![Staicman invitation screenshot](https://user-images.githubusercontent.com/5748535/50357920-e8f25500-0557-11e9-9cb6-73f8b575c4f0.png)
### Adding Google Analytics to track page views