Metadata-Version: 2.1
Name: djangocms-uikit
Version: 0.1.3
Summary: A UiKit Plugin for the DjangoCMS Framework
Home-page: https://github.com/domlysi/djangocms-uikit
Author: Dominik Lysiak
Author-email: dominik.lysiak@freenet.de
License: BSD License
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content

# 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](http://docs.django-cms.org/en/release-3.4.x/introduction/install.html) - 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:
```html
{% 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:
```html
{% addtoblock 'js' %}
<script src="https://cdnjs.cloudflare.com/ajax/libs/uikit/3.1.7/js/uikit.min.js" type="text/javascript"></script>
{% endaddtoblock %}
```
and

```html
{% 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](https://github.com/divio/django-cms) - The easy-to-use and developer-friendly CMS

## Authors

* **Dominik Lysiak** - *Main Contributor* - [Personal Website](https://dominiklysiak.de)

See also the list of [contributors](https://github.com/domlysi/djangocms-uikit/graphs/contributors) who participated in this project.

## License

This project is licensed - see the [LICENSE.md](LICENSE.md) file for details

## Todo

* Nearly everything for now

