# Panel box

A custom directive to creates boxes on subordinate `index.rst` files.

## Syntax

```rst
.. panel-box::
   <options>

   <text>
```

## Options

The `panel-box` directive supports the following options:

| Option   | Type   | Required                                                  | Example Value   | Description       |
|----------|--------|-----------------------------------------------------------|-----------------|-------------------|
| `title`  | string | <i class="inline-icon icon-check" aria-hidden="true"></i> | Lorem ipsum     | Hero box title.   |
| `class`  | string |                                                           |                 | Custom CSS class. |

## Usage

For example, using:

```rst
.. panel-box::
   :title: Title

   Body
```

Results in:


            <div class="cell ">
                <div class="panel">
                    <h5 class="panel_\_title">Title</h5>
            
Body

</div></div>

## Compatibility with previous versions

Some panel boxes in the open-source project where defined with raw html as follows:

```rst
.. raw:: html

  <div class="panel callout radius animated">
      <div class="row">
        <div class="medium-3 columns">
          <h5 id="getting-started">Title</h5>
        </div>
        <div class="medium-9 columns">
          Body
        </div>
      </div>
  </div>
```

This example tests how the previous panel box is rendered:

<div class="panel callout radius animated">
    <div class="row">
      <div class="medium-3 columns">
        <h5 id="getting-started">Title</h5>
      </div>
      <div class="medium-9 columns">
        Body
      </div>
    </div>
</div>