Metadata-Version: 2.0
Name: django-codetalker
Version: 0.1
Summary: a Django app to provide WordPress-likeshortcode functionality.
Home-page: https://github.com/vacuus/django-codetalker
Author: Alejandro Angulo
Author-email: aab.j13@gmail.com
License: LGPLv3
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content

Codetalker
==========

Codetalker is a simple Django app to include WordPress-like shortcode
functionality.

Detailed documentation is in the "docs" directory.

Quick start
-----------

1.  Add "codetalker" to your INSTALLED\_APPS setting like this:
    ```python
    INSTALLED_APPS = [
        ...
        'codetalker',
    ]
    ```

2.  Create a codetalker directory in your app to hold your parsers. Be
    sure to create a blank `__init__.py`.
3.  Parser functions should be defined like this:
    ```python
    def codetalker_command(*args):
      ... parse your command here...

    return html
    ```

    Notice, no imports are required in your parser file.

4.  Load `expand_codetalker` in your templates to have your 'shortcode' parsed:
    ```
    {% load codetalker %}
    ...
    {{ post.body|expand_shortcodes|safe }}
    ...
    ```


