Skip to main content

a Django app to provide WordPress-likeshortcode functionality.

Project description

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 }}
...
```


Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Source Distribution

django-codetalker-0.1.tar.gz (3.6 kB view hashes)

Uploaded source

Built Distribution

django_codetalker-0.1-py3-none-any.whl (5.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page