django-cked's Introduction

Django CKEd

CKEditor and elFinder integration for Django Framework.

Provides a RichTextField and CKEditorWidget with upload and browse support.

Installation

    pip install django-cked

    pip install -e git+git://github.com/dead23angel/django-cked.git@master

Demo

We have prepared a demo project is available on the link https://github.com/DOOMer/django-cked-demo to demonstrate the application.

Configuration

Add cked to your INSTALLED_APPS setting.

Then set ELFINDER_OPTIONS in your settings:

    ELFINDER_OPTIONS = {
        ## required options
        'root': os.path.join(PROJECT_ROOT, 'media', 'uploads'),
        'URL': '/media/uploads/',
    }

And add CKEd URL include to your project urls.py file:

    url(r'^cked/', include('cked.urls')),

Settings

CKEDITOR_OPTIONS: CKEditor config. See http://docs.ckeditor.com/#!/guide/dev_configuration
ELFINDER_OPTIONS: elFinder config. See https://github.com/Studio-42/elFinder/wiki/Client-configuration-options

Usage

Model field

    from django.db import models
    from cked.fields import RichTextField


    class Entry(models.Model):
        text = RichTextField()

Widget

    from django import forms
    from cked.widgets import CKEditorWidget

    class MyForm(forms.Form):
        text = forms.CharField(widget=CKEditorWidget)