{"id":19692193,"url":"https://github.com/getgrav/grav-plugin-comments","last_synced_at":"2025-04-29T09:31:24.087Z","repository":{"id":2111283,"uuid":"42448827","full_name":"getgrav/grav-plugin-comments","owner":"getgrav","description":"Grav Comments Plugin","archived":false,"fork":false,"pushed_at":"2024-05-13T16:36:09.000Z","size":100,"stargazers_count":55,"open_issues_count":35,"forks_count":28,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-04-19T14:55:43.272Z","etag":null,"topics":["comment","comment-viewer","comments","discussion","grav","grav-plugin","recaptcha"],"latest_commit_sha":null,"homepage":"http://getgrav.org","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getgrav.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-09-14T13:01:08.000Z","updated_at":"2024-11-11T16:26:26.000Z","dependencies_parsed_at":"2023-11-10T15:04:14.114Z","dependency_job_id":"9e4e72ab-9409-4f70-81bd-cde4541786d9","html_url":"https://github.com/getgrav/grav-plugin-comments","commit_stats":{"total_commits":105,"total_committers":20,"mean_commits":5.25,"dds":0.2857142857142857,"last_synced_commit":"6855c12a424f233970fad050b52a365726114bb3"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgrav%2Fgrav-plugin-comments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgrav%2Fgrav-plugin-comments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgrav%2Fgrav-plugin-comments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgrav%2Fgrav-plugin-comments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getgrav","download_url":"https://codeload.github.com/getgrav/grav-plugin-comments/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251248220,"owners_count":21558992,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comment","comment-viewer","comments","discussion","grav","grav-plugin","recaptcha"],"created_at":"2024-11-11T19:12:32.936Z","updated_at":"2025-04-29T09:31:24.067Z","avatar_url":"https://github.com/getgrav.png","language":"PHP","readme":"# Grav Comments Plugin\n\nThe **Comments Plugin** for [Grav](http://github.com/getgrav/grav) adds the ability to add comments to pages, and moderate them.\n\n# Installation\n\nThe Comments plugin is easy to install with GPM.\n\n```\n$ bin/gpm install comments\n```\n\nOr clone from GitHub and put in the `user/plugins/comments` folder.\n\n# Usage\n\nAdd `{% include 'partials/comments.html.twig' with {'page': page} %}` to the template file where you want to add comments.\n\nFor example, in Antimatter, in `templates/item.html.twig`:\n\n```twig\n{% embed 'partials/base.html.twig' %}\n\n    {% block content %}\n        {% if config.plugins.breadcrumbs.enabled %}\n            {% include 'partials/breadcrumbs.html.twig' %}\n        {% endif %}\n\n        \u003cdiv class=\"blog-content-item grid pure-g-r\"\u003e\n            \u003cdiv id=\"item\" class=\"block pure-u-2-3\"\u003e\n                {% include 'partials/blog_item.html.twig' with {'blog':page.parent, 'truncate':false} %}\n            \u003c/div\u003e\n            \u003cdiv id=\"sidebar\" class=\"block size-1-3 pure-u-1-3\"\u003e\n                {% include 'partials/sidebar.html.twig' with {'blog':page.parent} %}\n            \u003c/div\u003e\n        \u003c/div\u003e\n\n        {% include 'partials/comments.html.twig' with {'page': page} %}\n    {% endblock %}\n\n{% endembed %}\n```\n\nThe comment form will appear on the blog post items matching the enabled routes.\n\nTo set the enabled routes, create a `user/config/plugins/comments.yaml` file, copy in it the contents of `user/plugins/comments/comments.yaml` and edit the `enable_on_routes` and `disable_on_routes` options according to your needs.\n\n\u003e Make sure you configured the \"Email from\" and \"Email to\" email addresses in the Email plugin with your email address!\n\n# Enabling Recaptcha\n\nThe plugin comes with Recaptcha integration. To make it work, create a `user/config/plugins/comments.yaml` file, copy in it the contents of `user/plugins/comments/comments.yaml` and uncomment the captcha form field and the captcha validation process.\nMake sure you add your own Recaptcha `site` and `secret` keys too.\n\n# Where are the comments stored?\n\nIn the `user/data/comments` folder. They're organized by page route, so every page with a comment has a corresponding file. This enables a quick load of all the page comments.\n\n# Visualize comments\n\nWhen 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.\n\nFurther improvements to the comments visualization will be added in the next releases.\n\n# Email notifications\n\nThe plugin interacts with the Email plugin to send emails upon receiving a comment. Configure the Email plugin correctly, setting its \"Email from\" and \"Email to\" email addresses.\n\n# Things still missing\n\n- Allow to delete comments from the Admin Plugin\n- Ability to see all comments of a page in the Admin Plugin\n- Ability to reply to a comment from the Admin Plugin\n- Auto-fill the comment form when a user is logged in\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetgrav%2Fgrav-plugin-comments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetgrav%2Fgrav-plugin-comments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetgrav%2Fgrav-plugin-comments/lists"}