README
.. django-utrechtstijl documentation master file, created by startproject.
You can adapt this file completely to your liking, but it should at least
contain the root toctree
directive.
Welcome to django-utrechtstijl's documentation!
:Source: https://github.com/GemeenteUtrecht/django-utrechtstijl
:Keywords: templates
, HTML
, CSS
:PythonVersion: 3.7
|build-status| |coverage| |black|
|python-versions| |django-versions| |pypi-version|
The Utrecht web style as Django tmeplates and assets
.. contents::
.. section-numbering::
The styles are taken from https://github.com/GemeenteUtrecht/Designs
Features
- Re-useable/extensible templates
- Form widgets library
Installation
Requirements
- Python 3.7 or above
- setuptools 30.3.0 or above
- Django 2.2 or above
Install
.. code-block:: bash
pip install django-utrechtstijl
Add to your INSTALLED_APPS
setting:
.. code-block:: python
INSTALLED_APPS = [
...,
"django.contrib.staticfiles",
"sniplates",
"django_utrechtstijl",
...
]
Usage
Extend and/or include the templates that ship with the project.
By default, the utrechtstijl/css/screen.css
stylesheet is loaded. You can
customize this with the context variable CSS_MAIN
.
.. |build-status| image:: https://travis-ci.org/GemeenteUtrecht/django-utrechtstijl.svg?branch=master :target: https://travis-ci.org/GemeenteUtrecht/django-utrechtstijl
.. |coverage| image:: https://codecov.io/gh/GemeenteUtrecht/django-utrechtstijl/branch/master/graph/badge.svg :target: https://codecov.io/gh/GemeenteUtrecht/django-utrechtstijl :alt: Coverage status
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-utrechtstijl.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-utrechtstijl.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/django-utrechtstijl.svg :target: https://pypi.org/project/django-utrechtstijl/
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black