Skip to content
This repository has been archived by the owner on Feb 11, 2020. It is now read-only.

Commit

Permalink
Improved panels documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
timorieber committed May 6, 2015
1 parent d9238e5 commit d0a7c85
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 2 deletions.
51 changes: 50 additions & 1 deletion docs/components/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,58 @@ This renders the following html code::
</div>
</div>

Panel with footer
Panel with heading
******************

Add a nested ``panel-heading``::

{% panel %}
{% panelheading %}
Your panel heading
{% endpanelheading %}
{% panelbody %}
Lorem ipsum.
{% endpanelbody %}
{% endpanel %}

This renders the following html code::

<div class="panel panel-default">
<div class="panel-heading">
Your panel heading
</div>
<div class="panel-body">
Lorem ipsum.
</div>
</div>

In addition you may specify a ``panel-title`` within ``panel-heading`` using ``h1`` to ``h6``::

{% panel %}
{% panelheading %}
{% paneltitle use_tag="h1" %}
Your panel heading
{% panelheading %}
{% endpanelheading %}
{% panelbody %}
Lorem ipsum.
{% endpanelbody %}
{% endpanel %}

This renders the following html code::

<div class="panel panel-default">
<div class="panel-heading">
Your panel heading
</div>
<div class="panel-body">
Lorem ipsum.
</div>
</div>

Panel with footer
*****************

Add a nested ``panel-footer``::

{% panel %}
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

setup(
name='django-bootstrap-ui',
version='0.1.0-alpha.3',
version='0.1.0a5',
packages=find_packages(exclude=['tests', 'docs']),
include_package_data=True,
license='ISC License (ISCL)',
Expand Down

0 comments on commit d0a7c85

Please sign in to comment.