djangocms-uikit

A UiKit Plugin for the DjangoCMS Framework


License
BSD-3-Clause
Install
pip install djangocms-uikit==0.1.3

Documentation

DjangoCMS UiKit

This package implements the UIKit Elements as reusable Plugins for the DjangoCMS.

Prerequisites

You need a Django CMS Project. If you wanna know how to start a Django CMS Project check the the Docs.

Django-CMS.org - Installing Django CMS

Quick Start

Install DjangoCMS-UIKit:

python3 -m pip install djangocms-uikit

Then add djangocms-uikit to INSTALLED_APPS

Don't forget:

python3 manage.py makemigrations
python3 manage.py migrate

Next download the UIKit Files or add the CDNs to your project main template.

Before the </head> tag:

{% addtoblock 'css' %}
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/uikit/3.1.7/css/uikit.min.css">
{% endaddtoblock %}

Before the </body> tag:

{% addtoblock 'js' %}
<script src="https://cdnjs.cloudflare.com/ajax/libs/uikit/3.1.7/js/uikit.min.js" type="text/javascript"></script>
{% endaddtoblock %}

and

{% addtoblock 'js' %}
<script src="https://cdnjs.cloudflare.com/ajax/libs/uikit/3.1.7/js/uikit-icons.min.js" type="text/javascript"></script>
{% endaddtoblock %}

Built With

  • DjangoCms - The easy-to-use and developer-friendly CMS

Authors

See also the list of contributors who participated in this project.

License

This project is licensed - see the LICENSE.md file for details

Todo

  • Nearly everything for now