Metadata-Version: 2.0
Name: django-orgco
Version: 0.1.0
Summary: django-orgco implements a template tag to use orgco easily in django templates
Home-page: https://github.com/paetzke/django-orgco
Author: Friedrich Paetzke
Author-email: f.paetzke@gmail.com
License: BSD
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Text Editors :: Emacs
Classifier: Topic :: Text Processing
Classifier: Topic :: Text Processing :: Markup
Requires-Dist: django
Requires-Dist: orgco (>=0.0.11)

django-orgco
============

.. image:: https://travis-ci.org/paetzke/django-orgco.png?branch=master
  :target: https://travis-ci.org/paetzke/django-orgco
.. image:: https://coveralls.io/repos/paetzke/django-orgco/badge.png?branch=master
  :target: https://coveralls.io/r/paetzke/django-orgco?branch=master

Copyright (c) 2013, Friedrich Paetzke (f.paetzke@gmail.com)
All rights reserved.

django-orgco implements a template tag to use orgco easily in django templates.

How to use
----------

Install the package via ``pip``

.. code:: bash

    $ pip install django-orgco

Add the package to your installed apps in settings.py.

.. code:: python

    INSTALLED_APPS = (
        ...
        'django_orgco',
        ...
    )

Then use it. Here is an example:

my_template.html:

.. code:: html

    {% load orgdoc %}

    {% orgdoc %}
    * header is here

    - short1 :: long1
    - short2 :: long2
    - short3 :: long3

    | th1 | th2 |
    |-----+-----|
    | td1 | td2 |
    {% endorgdoc %}

To enable code highlighting add *highlight* to *orgdoc*:

.. code:: html

    {% orgdoc highlight %}
    is_ok = True
    {% endorgdoc %}

The tag does not produce safe output by default. You have to mark it as safe yourself:

.. code:: html

    {% load orgdoc %}
    {% orgdoc highlight %}
    {{ code|safe }}
    {% endorgdoc %}

.. image:: https://d2weczhvl823v0.cloudfront.net/paetzke/django-orgco/trend.png
  :target: https://bitdeli.com/free



