Was this page helpful?
Panel box¶
A custom directive to creates boxes on subordinate index.rst files.
Warning
Do not use the panel-box on the root index.rst.
Syntax¶
.. panel-box::
<options>
<text>
Options¶
The panel-box directive supports the following options:
Option |
Type |
Required |
Example Value |
Description |
|---|---|---|---|---|
|
string |
Lorem ipsum |
Hero box title. |
|
|
string |
Custom CSS class. |
Usage¶
For example, using:
.. panel-box::
:title: Title
Body
Results in:
Title
Body
Compatibility with previous versions¶
Some panel boxes in the open-source project where defined with raw html as follows:
.. 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:
Title
Body