Skip to main content

django-email-foundation is a Django package for help you to create emails using the "zurb foundation" technologies

Project description

.. django-email-foundation documentation master file, created by
sphinx-quickstart on Mon Mar 11 23:49:58 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

=======================
django-email-foundation
=======================

Description
===========

This is a Django package that helps you build email templates for your email engine sender (we recommend you use `django-yubin`_).
It uses the `zurb foundation for emails`_ templates and *node* packages such as *inky* or *panini*.

.. _django-yubin: https://github.com/APSL/django-yubin
.. _zurb foundation for emails: https://foundation.zurb.com/emails/docs/

It provides you with some commands and functionality to integrate *zurb foundation for emails* in your django project.

* *install_requires*: A command to install the required node packages, such as *inky*, *panini*, *gulp*, etc in your project.
* *create_basic_structure*: It creates an essential tree structure in your project, that contains the basic layout and folders
such as *pages*, *helpers* and *partials*, used by panini_.
* *email_builder*: Starts a *gulp* process that watches your source templates, builds them and finally copies them to your target email folder. It compiles the sources using panini_ and inky_ for the best compatibility with the major email's client.

It also gives you a django view to preview the generated templates. For the preview, you can use a custom fixed context for each template, and this is very useful because it allows designers to edit the layouts.

.. _panini: https://www.npmjs.com/package/panini
.. _inky: https://www.npmjs.com/package/inky

Index
=====

.. toctree::

installation
commands
preview
context
contributing



Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-email-foundation, version 0.0.11
Filename, size File type Python version Upload date Hashes
Filename, size django_email_foundation-0.0.11-py3-none-any.whl (38.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size django-email-foundation-0.0.11.tar.gz (22.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page