django-uikit-editor

uikit_editor provides integration for UiKit htmleditor with Django


License
BSD-2-Clause
Install
pip install django-uikit-editor==0.0.1

Documentation

UiKit editor for Django

What's that

uikit_editor is a reusable application for Django, using UiKit editor

Dependence

  • Django >= 1.3

Getting started

  • Install uikit_editor:

`pip install django-uikit-editor`

  • Add 'uikit_editor' to INSTALLED_APPS.

Using in model

from django.db import models
from uikit_editor import UiKitField

class Entry(models.Model):
    title = models.CharField(max_length=250, verbose_name=u'Title')
    text = UiKitField(verbose_name=u'Text')

or use custom parametrs:

text = UiKitField(
    verbose_name=u'Text',
    mode="tab", # 'split', 'tab' default 'split'
    markdown=True #default False
)

Using for only admin interface

from django import forms
from uikit_editor import UiKitWidget
from blog.models import Entry

class EntryAdminForm(forms.ModelForm):
    class Meta:
        model = Entry
        widgets = {
           'text': UiKitWidget(),
        }

class EntryAdmin(admin.ModelAdmin):
    form = EntryAdminForm

UiKitWidget takes the same parameters as UiKitField.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request =]