# Grav Comments Plugin The **Comments Plugin** for [Grav](http://github.com/getgrav/grav) adds the ability to add comments to pages, and moderate them. | IMPORTANT!!! This plugin is currently in development as is to be considered a **beta release**. As such, use this in a production environment **at your own risk!**. More features will be added in the future. # Installation The Comments plugin is easy to install with GPM. ``` $ bin/gpm install comments ``` Or clone from GitHub and put in the `user/plugins/comments` folder. # Usage Add `{% include 'partials/comments.html.twig' with {'page': page} %}` to the template file where you want to add comments. For example, in Antimatter, in `templates/item.html.twig`: ```twig {% embed 'partials/base.html.twig' %} {% block content %} {% if config.plugins.breadcrumbs.enabled %} {% include 'partials/breadcrumbs.html.twig' %} {% endif %}
{% include 'partials/blog_item.html.twig' with {'blog':page.parent, 'truncate':false} %}
{% include 'partials/comments.html.twig' with {'page': page} %} {% endblock %} {% endembed %} ``` The comment form will appear to the blog post items. # Enable the Captcha anti-spam filter To reduce spam in your comments, enable the Google Recaptcha integration we added. Copy the plugin's `comments.yaml` to `user/config/plugins/comments.yaml` and enable `use_captcha`. Also add the Google Recaptcha API keys to allow it to work correctly. # Where are the comments stored? In the `user/data/comments` folder. They're organized by page route, so every page with a comment has a corresponding file. This enabled a quick load of all the page comments. # Visualize comments When the plugin is installed and enabled, the `Comments` menu will appear in the Admin Plugin. From there you can see all the comments made in the last 7 days. Further improvements to the comments visualization will be added in the next releases. # Email notifications Upon receiving a comment, if `enable_email_notifications` is enabled, the Comments plugin will send an email to the `notifications_email_to` address set in the plugin options. # Things still missing - Add language file - Allow to delete comments from the Admin Plugin - Allow some pages to disable adding comments - Ability to see all comments of a page in the Admin Plugin - Ability to reply to a comment from the Admin Plugin - Auto-fill the comment form when a user is logged in