Metadata-Version: 2.0
Name: django-shortcodes
Version: 0.4.0
Summary: WordPress shortcode support for Django
Home-page: https://github.com/martey/django-shortcodes
Author: Martey Dodoo
Author-email: django-shortcodes@marteydodoo.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License

=================
django-shortcodes
=================

This package provides `WordPress shortcode
<https://en.support.wordpress.com/shortcodes/>`_ support for Django
templates. It is based on code by `Mark Steadman <https://about.me/steadman>`_.

Support for different shortcodes are generated by parsers. The package
currently includes a parser for YouTube videos. Additional parsers can be
submitted for inclusion at the package's `issue
tracker <https://github.com/martey/django-shortcodes/issues>`_.

Installation
============

Use ``pip install django-shortcodes`` or clone the `Git
repository <https://github.com/martey/django-shortcodes>`_.

Usage
=====

::

    {% load shortcodes_filters %}
    {{ text|shortcodes|safe }}

Settings
========

Vimeo
-----

- ``SHORTCODES_VIMEO_HEIGHT``: Default height for Vimeo videos.
- ``SHORTCODES_VIMEO_WIDTH``: Default width for Vimeo videos.

YouTube
-------

- ``SHORTCODES_YOUTUBE_JQUERY``: Boolean whether the
  `jquery.flash plugin <https://github.com/Qard/jquery-flash>`_ is
  available.
- ``SHORTCODES_YOUTUBE_HEIGHT``: Default height for YouTube videos.
- ``SHORTCODES_YOUTUBE_WIDTH``: Default width for YouTube videos.


