{"id":18831411,"url":"https://github.com/django-cms/djangocms-bootstrap5","last_synced_at":"2025-10-30T06:45:13.589Z","repository":{"id":39999251,"uuid":"426957348","full_name":"django-cms/djangocms-bootstrap5","owner":"django-cms","description":"django CMS Bootstrap 5 is a plugin bundle for django CMS providing several components from the popular Bootstrap 5 framework. ","archived":false,"fork":false,"pushed_at":"2023-01-31T14:18:39.000Z","size":173,"stargazers_count":5,"open_issues_count":8,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-14T04:16:10.910Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://django-cms.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/django-cms.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-11T10:20:55.000Z","updated_at":"2025-04-01T11:17:53.000Z","dependencies_parsed_at":"2023-02-16T19:55:17.902Z","dependency_job_id":null,"html_url":"https://github.com/django-cms/djangocms-bootstrap5","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-cms%2Fdjangocms-bootstrap5","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-cms%2Fdjangocms-bootstrap5/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-cms%2Fdjangocms-bootstrap5/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/django-cms%2Fdjangocms-bootstrap5/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/django-cms","download_url":"https://codeload.github.com/django-cms/djangocms-bootstrap5/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248819409,"owners_count":21166477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T01:54:08.331Z","updated_at":"2025-10-30T06:45:13.517Z","avatar_url":"https://github.com/django-cms.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"======================\ndjango CMS Bootstrap 5 (WIP)\n======================\n\n|pypi| |build| |coverage|\n\n**django CMS Bootstrap 5** is a plugin bundle for django CMS providing several\ncomponents from the popular `Bootstrap 5 \u003chttp://getbootstrap.com/\u003e`_ library.\n\n\n.. note:: \n        \n        This project is endorsed by the `django CMS Association \u003chttps://www.django-cms.org/en/about-us/\u003e`_.\n        That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy. \n        Join us on `Slack \u003chttps://www.django-cms.org/slack/\u003e`_.\n        \n.. image:: preview.gif\n\n\nContributing\n============\n\nThis is a an open-source project. We'll be delighted to receive your\nfeedback in the form of issues and pull requests. Before submitting your\npull request, please review our `contribution guidelines\n\u003chttp://docs.django-cms.org/en/latest/contributing/index.html\u003e`_.\n\nWe're grateful to all contributors who have helped create and maintain this package.\nContributors are listed at the `contributors \u003chttps://github.com/divio/djangocms-bootstrap5/graphs/contributors\u003e`_\nsection.\n\nOne of the easiest contributions you can make is helping to translate this addon on\n`Transifex \u003chttps://www.transifex.com/projects/p/djangocms-bootstrap5/\u003e`_.\n\n\nDocumentation\n=============\n\nSee ``REQUIREMENTS`` in the `setup.py \u003chttps://github.com/divio/djangocms-bootstrap5/blob/master/setup.py\u003e`_\nfile for additional dependencies:\n\n|python| |django| |djangocms|\n\n* Django Filer 1.7 or higher\n* Django Text CKEditor 3.1 or higher\n\nMake sure `django Filer \u003chttp://django-filer.readthedocs.io/en/latest/installation.html\u003e`_\nand `django CMS Text CKEditor \u003chttps://github.com/divio/djangocms-text-ckeditor\u003e`_\nare installed and configured appropriately.\n\n\nInstallation\n------------\n\nFor a manual install:\n\n* run ``pip install djangocms-bootstrap5``\n* add the following entries to your ``INSTALLED_APPS``::\n\n    'djangocms_icon',\n    'djangocms_link',\n    'djangocms_picture',\n    'djangocms_bootstrap5',\n    'djangocms_bootstrap5.contrib.bootstrap5_alerts',\n    'djangocms_bootstrap5.contrib.bootstrap5_badge',\n    'djangocms_bootstrap5.contrib.bootstrap5_card',\n    'djangocms_bootstrap5.contrib.bootstrap5_carousel',\n    'djangocms_bootstrap5.contrib.bootstrap5_collapse',\n    'djangocms_bootstrap5.contrib.bootstrap5_content',\n    'djangocms_bootstrap5.contrib.bootstrap5_grid',\n    'djangocms_bootstrap5.contrib.bootstrap5_jumbotron',\n    'djangocms_bootstrap5.contrib.bootstrap5_link',\n    'djangocms_bootstrap5.contrib.bootstrap5_listgroup',\n    'djangocms_bootstrap5.contrib.bootstrap5_media',\n    'djangocms_bootstrap5.contrib.bootstrap5_picture',\n    'djangocms_bootstrap5.contrib.bootstrap5_tabs',\n    'djangocms_bootstrap5.contrib.bootstrap5_utilities',\n\n* run ``python manage.py migrate``\n\n\nConfiguration\n-------------\n\ndjango CMS Bootstrap 5 **utilises** the following django CMS plugins:\n\n* **django CMS Link**: `Link \u003chttps://github.com/divio/djangocms-link/\u003e`_\n* **django CMS Picture**: `Picture \u003chttps://github.com/divio/djangocms-picture/\u003e`_\n* **django CMS Icon**: `Icon \u003chttps://github.com/divio/djangocms-icon\u003e`_\n\nIt provides the following **standard** Bootstrap 5 components:\n\n* `Alerts \u003chttps://getbootstrap.com/docs/5.0/components/alerts/\u003e`_\n* `Badge \u003chttps://getbootstrap.com/docs/5.0/components/badge/\u003e`_\n* `Card \u003chttps://getbootstrap.com/docs/5.0/components/card/\u003e`_\n* `Carousel \u003chttps://getbootstrap.com/docs/5.0/components/carousel/\u003e`_\n* `Collapse \u003chttps://getbootstrap.com/docs/5.0/components/collapse/\u003e`_\n* `Content (Blockquote, Code, Figure) \u003chttps://getbootstrap.com/docs/5.0/content/\u003e`_\n* `Grid (Container, Row, Column) \u003chttps://getbootstrap.com/docs/5.0/layout/grid/\u003e`_\n* `Jumbotron \u003chttps://getbootstrap.com/docs/5.0/components/jumbotron/\u003e`_\n* `Link / Button \u003chttps://getbootstrap.com/docs/5.0/components/buttons/\u003e`_\n* `List group \u003chttps://getbootstrap.com/docs/5.0/components/list-group/\u003e`_\n* `Media \u003chttps://getbootstrap.com/docs/5.0/layout/media-object/\u003e`_\n* `Picture / Image \u003chttps://getbootstrap.com/docs/5.0/content/images/\u003e`_\n* `Tabs \u003chttps://getbootstrap.com/docs/5.0/components/navs/#tabs\u003e`_\n* `Utilities (Spacing) \u003chttps://getbootstrap.com/docs/5.0/utilities/\u003e`_\n\ndjango CMS Bootstrap 5 **does not** add the styles or javascript files to your frontend, these need to be added at your discretion.\n\n\nSettings\n~~~~~~~~\n\nThere are various settings possible on django CMS Bootstrap 5, to restrict them\nfor now only the following can be changed::\n\n    DJANGOCMS_BOOTSTRAP5_TAG_CHOICES = ['div', 'section', 'article', 'header', 'footer', 'aside']\n\n    DJANGOCMS_BOOTSTRAP5_CAROUSEL_TEMPLATES = (\n        ('default', _('Default')),\n    )\n\n    DJANGOCMS_BOOTSTRAP5_GRID_SIZE = 12\n    DJANGOCMS_BOOTSTRAP5_GRID_CONTAINERS = (\n        ('container', _('Container')),\n        ('container-fluid', _('Fluid container')),\n    )\n    DJANGOCMS_BOOTSTRAP5_GRID_COLUMN_CHOICES = (\n        ('col', _('Column')),\n        ('w-100', _('Break')),\n        ('', _('Empty'))\n    )\n\n    DJANGOCMS_BOOTSTRAP5_USE_ICONS = True\n\n    DJANGOCMS_BOOTSTRAP5_TAB_TEMPLATES = (\n        ('default', _('Default')),\n    )\n\n    DJANGOCMS_BOOTSTRAP5_SPACER_SIZES = (\n        ('0', '* 0'),\n        ('1', '* .25'),\n        ('2', '* .5'),\n        ('3', '* 1'),\n        ('4', '* 1.5'),\n        ('5', '* 3'),\n    )\n\n    DJANGOCMS_BOOTSTRAP5_CAROUSEL_ASPECT_RATIOS = (\n        (16, 9),\n    )\n\n    DJANGOCMS_BOOTSTRAP5_COLOR_STYLE_CHOICES = (\n        ('primary', _('Primary')),\n        ('secondary', _('Secondary')),\n        ('success', _('Success')),\n        ('danger', _('Danger')),\n        ('warning', _('Warning')),\n        ('info', _('Info')),\n        ('light', _('Light')),\n        ('dark', _('Dark')),\n        ('custom', _('Custom')),\n    )\n\nPlease be aware that this package does not support djangocms-text-ckeditor's\n`Drag \u0026 Drop Images \u003chttps://github.com/divio/djangocms-text-ckeditor/#drag--drop-images\u003e`_\nso be sure to set ``TEXT_SAVE_IMAGE_FUNCTION = None``.\n\n\nRunning Tests\n-------------\n\nYou can run tests by executing::\n\n    virtualenv env\n    source env/bin/activate\n    pip install -r tests/requirements.txt\n    python setup.py test\n\nTo run the frontend make sure to use **node 10.x**.\n\n\n.. |pypi| image:: https://badge.fury.io/py/djangocms-bootstrap5.svg\n    :target: http://badge.fury.io/py/djangocms-bootstrap5\n.. |build| image:: https://travis-ci.org/divio/djangocms-bootstrap5.svg?branch=master\n    :target: https://travis-ci.org/divio/djangocms-bootstrap5\n.. |coverage| image:: https://codecov.io/gh/divio/djangocms-bootstrap5/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/divio/djangocms-bootstrap5\n\n.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg\n    :target: https://pypi.org/project/djangocms-bootstrap5/\n.. |django| image:: https://img.shields.io/badge/django-2.2,%203.0,%203.1-blue.svg\n    :target: https://www.djangoproject.com/\n.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg\n    :target: https://www.django-cms.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjango-cms%2Fdjangocms-bootstrap5","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdjango-cms%2Fdjangocms-bootstrap5","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjango-cms%2Fdjangocms-bootstrap5/lists"}