<commit_before># Preview

Preview is simple PHP tool for showing image of the website inside one of available devices. It can be useful to test what area of the layout is visible at once on various screen sizes.

## Usage

To add or modify sections to index page, use `config.php` file located in root directory.

```php
<?php

return [
  'name' => 'Project Name',
  'sections' => [
    [
      'name' => 'Section Name',
      'layout' => 'columns',
      'items' => [
        [
          'name' => 'Item Name',
          'type' => 'file',
          'url' => '',
          'icon' => '',
          'class' => 'done',
        ],
      ],
    ],
  ],
];
```

## Options

There is number of options to configure look and content of index page.

### Global

<table>
  <thead>
    <tr>
      <th>Property</th>
      <th>Default</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row"><code>name</code></th>
      <td><code>""</code></td>
      <td><code>String</code> Project name displayed at the top of index page.</td>
    </tr>
    <tr>
      <th scope="row"><code>sections</code></th>
      <td><code>[]</code></td>
      <td><code>Array</code> Array of sections containing items.</td>
    </tr>
  </tbody>
</table>

### Section

<table>
  <thead>
    <tr>
      <th>Property</th>
      <th>Default</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row"><code>name</code></th>
      <td><code>""</code></td>
      <td><code>String</code> Name of the section.</td>
    </tr>
    <tr>
      <th scope="row"><code>layout</code></th>
      <td><code>"single"</code></td>
      <td><code>String</code> Accepts: `"single"` or `"split"`. Split layout shows two columns with items instead of one.</td>
    </tr>
    <tr>
      <th scope="row"><code>items</code></th>
      <td><code>[]</code></td>
      <td><code>Array</code> Array of items in section.</td>
    </tr>
  </tbody>
</table><commit_msg>Add information about description property<commit_after># Preview

Preview is simple PHP tool for showing image of the website inside one of available devices. It can be useful to test what area of the layout is visible at once on various screen sizes.

## Usage

To add or modify sections to index page, use `config.php` file located in root directory.

```php
<?php

return [
  'name' => 'Project Name',
  'sections' => [
    [
      'name' => 'Section Name',
      'layout' => 'columns',
      'items' => [
        [
          'name' => 'Item Name',
          'description' => '',
          'type' => 'file',
          'url' => '',
          'icon' => '',
          'class' => 'done',
        ],
      ],
    ],
  ],
];
```

## Options

There is number of options to configure look and content of index page.

### Global

<table>
  <thead>
    <tr>
      <th>Property</th>
      <th>Default</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row"><code>name</code></th>
      <td><code>""</code></td>
      <td><code>String</code> Project name displayed at the top of index page.</td>
    </tr>
    <tr>
      <th scope="row"><code>sections</code></th>
      <td><code>[]</code></td>
      <td><code>Array</code> Array of sections containing items.</td>
    </tr>
  </tbody>
</table>

### Section

<table>
  <thead>
    <tr>
      <th>Property</th>
      <th>Default</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <th scope="row"><code>name</code></th>
      <td><code>""</code></td>
      <td><code>String</code> Name of the section.</td>
    </tr>
    <tr>
      <th scope="row"><code>description</code></th>
      <td><code>""</code></td>
      <td><code>String</code> Optional description for the item.</td>
    </tr>
    <tr>
      <th scope="row"><code>layout</code></th>
      <td><code>"single"</code></td>
      <td><code>String</code> Accepts: `"single"` or `"split"`. Split layout shows two columns with items instead of one.</td>
    </tr>
    <tr>
      <th scope="row"><code>items</code></th>
      <td><code>[]</code></td>
      <td><code>Array</code> Array of items in section.</td>
    </tr>
  </tbody>
</table>
{'fraction_non_alphanumeric': 0.20057581573896352, 'fraction_numerical': 0.0, 'mean_word_length': 2.4144144144144146, 'pattern_counts': {'":': 0, '<': 215, '<?xml version=': 0, '>': 234, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '698090', 'n_tokens_mistral': 1419, 'n_tokens_neox': 1401, 'n_words': 375}