django-ckeditor / README.md

Django CKEditor

Django CKEditor contains the JavaScript WYSIWYG editor, CKEditor and functionality for uploading and browsing files on your server.

Installation

Run pip install django-ckedit

Add ckeditor to your INSTALLED_APPS setting:

INSTALLED_APPS = (
    ...
    'ckeditor',
)

To your sites url.py add:

urlpatterns = patterns('',
    ...
    url(r'^ckeditor/', include('ckeditor.urls')),
)

Views

upload

Uploads a file from the CKEditor insert image dialog's upload section to a user-specified path using the default storage.

browse

Displays image thumbnails from the CKEditor insert image dialog's browse section.

Settings

CKEDTIOR_UPLOAD_DIRECTORY (default 'ckeditor')

The directory the uploads are saved to and files are browsed from.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.