<commit_before># Kirby Comments

File based comments stored as subpages. Easy to setup. Easy to use. Flexible as hell.

<img src="screenshots/form.png" srcset="screenshots/form.png 1x, screenshots/form@2x.png 2x">

## Installation

1. Move the folder “comments” to site/plugins.
2. Move all files inside of “snippets” to site/snippets.

## Usage

To use the comments snippet, include it on the page where the comments and the comments form should appear on.

```php
<div class="comments">
  <?php snippet('comments') ?>
</div>
```

## Options

Options may be set by calling `c::set('comments.OPTION_NAME', $value)` in your config.php.

```php
c::set('comments.use.email', true);
c::set('comments.email.to', array('<EMAIL>'));
```

| Name | Type | Default | Description |<commit_msg>Add Features List<commit_after># Kirby Comments

File based comments stored as subpages. Easy to setup. Easy to use. Flexible as hell.

<img src="screenshots/form.png" srcset="screenshots/form.png 1x, screenshots/form@2x.png 2x">

## Features

- file-based
- email-notifications for new comments
- preview comments before submitting them
- use honeypot to prevent spam
- tons of options

## Installation

1. Move the folder “comments” to site/plugins.
2. Move all files inside of “snippets” to site/snippets.

## Usage

To use the comments snippet, include it on the page where the comments and the comments form should appear on.

```php
<div class="comments">
  <?php snippet('comments') ?>
</div>
```

## Options

Options may be set by calling `c::set('comments.OPTION_NAME', $value)` in your config.php.

```php
c::set('comments.use.email', true);
c::set('comments.email.to', array('<EMAIL>'));
```

| Name | Type | Default | Description |
{'fraction_non_alphanumeric': 0.1373913043478261, 'fraction_numerical': 0.005797101449275362, 'mean_word_length': 4.54983922829582, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '998161', 'n_tokens_mistral': 568, 'n_tokens_neox': 533, 'n_words': 199}