Adds Bootstrap 3 components as plugins.
Aldryn Bootstrap 3 is a plugin bundle for django CMS providing several components from the popular Bootstrap 3 framework.
This is a an open-source project. We’ll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.
One of the easiest contributions you can make is helping to translate this addon on Transifex.
See REQUIREMENTS in the setup.py file for additional dependencies:
- Python 2.7, 3.3 or higher
- Django 1.6 or higher
- Django Filer 1.2.4 or higher
- Django Text CKEditor 3.1.0 or higher
For a manual install:
- run pip install aldryn-bootstrap3
- add aldryn_bootstrap3 to your INSTALLED_APPS
- run python manage.py migrate aldryn_bootstrap3
Aldryn Bootstrap 3 replaces the following django CMS plugins:
It provides the following standard Bootstrap 3 components:
- Grid (Row and Column)
- List Group
- Panel (Heading, Body and Footer)
It also provides the following 3rd party components:
These components need to be manually configured in order to work properly inside your project. See this gist for additional information on a recommended spacer configuration.
This addon provides a standard template for Carousels. You can provide additional style choices by adding a ALDRYN_BOOTSTRAP3_CAROUSEL_STYLES setting:
ALDRYN_BOOTSTRAP3_CAROUSEL_STYLES = [ ('feature', _('Featured Version')), ]
You’ll need to create the feature folder inside templates/aldryn_bootstrap/plugins/carousel/ otherwise you will get a template does not exist error. You can do this by copying the standard folder inside that directory and renaming it to feature.
In addition you can set or extend your own icon fonts using ALDRYN_BOOTSTRAP3_ICONSETS:
ALDRYN_BOOTSTRAP3_ICONSETS = [ ('glyphicons', 'glyphicons', 'Glyphicons'), ('fontawesome', 'fa', 'Font Awesome'), ('icons', 'icon', 'Custom Icons'), ]
The default grid size is set to 24 when validating the column input, you can override this by setting:
ALDRYN_BOOTSTRAP3_GRID_SIZE = 12
You can run tests by executing:
virtualenv env source env/bin/activate pip install -r tests/requirements.txt python setup.py test