Medium Editor widget for Django
Project description
# Django Medium Editor
Adds [Medium Editor](https://yabwe.github.io/medium-editor/) to [Django](https://www.djangoproject.com/).
## Supported Environments
* Django 1.10+
* Python 3.6
## Installation
1. Install **django-mediumeditor**
via PyPi:
```
pip install django-mediumeditor
```
via GIT:
```
pip install git+https://github.com/g3rd/django-mediumeditor.git
```
2. Install app
```
INSTALLED_APPS = [
...
'mediumeditor',
]
```
## Usage
### Django Admin
Add to Admin class
```
from mediumeditor.admin import MediumEditorAdmin
@admin.register(MyModel)
class MyModelAdmin(MediumEditorAdmin, admin.ModelAdmin):
...
mediumeditor_fields = ('my_text_field', )
...
```
### Forms
1. Override the Widget for the field
```
from mediumeditor.widgets import MediumEditorTextarea
class MyForm(forms.ModelForm):
...
class Meta:
model = MyModel
widgets = {
'my_text_field': MediumEditorTextarea(),
}
```
2. In the ```<head>``` of the template
```
{{ form.media }}
```
### Settings
Optionaly change theme or change medium editor options in your settings.py
```
# Theme options `default`, `roman`, `mani`, `flat`, `bootstrap`, `tim`, `beagle`
MEDIUM_EDITOR_THEME = 'beagle' # `default` is defualt theme
MEDIUM_EDITOR_OPTIONS = {..}
```
[Available Options](https://github.com/yabwe/medium-editor/blob/master/OPTIONS.md)
Example:
```
MEDIUM_EDITOR_THEME = 'bootstrap'
MEDIUM_EDITOR_OPTIONS = {
'toolbar': {
'static': True,
'buttons': [
'bold',
'italic',
'underline',
'strikethrough',
'subscript',
'superscript',
'h1',
'h2',
'h3',
'h4',
'h5',
'h6',
]
},
'paste': {
'forcePlainText': True,
'cleanPastedHTML': False,
'cleanReplacements': [],
'cleanAttrs': ['class', 'style', 'dir'],
'cleanTags': ['meta']
}
}
```
## Contributing
[Take out some bugs](https://github.com/g3rd/django-mediumeditor/issues)
[Report issues or feature requests](https://github.com/g3rd/django-mediumeditor/issues)
## License
MIT: https://github.com/g3rd/django-mediumeditor/blob/master/LICENSE
Adds [Medium Editor](https://yabwe.github.io/medium-editor/) to [Django](https://www.djangoproject.com/).
## Supported Environments
* Django 1.10+
* Python 3.6
## Installation
1. Install **django-mediumeditor**
via PyPi:
```
pip install django-mediumeditor
```
via GIT:
```
pip install git+https://github.com/g3rd/django-mediumeditor.git
```
2. Install app
```
INSTALLED_APPS = [
...
'mediumeditor',
]
```
## Usage
### Django Admin
Add to Admin class
```
from mediumeditor.admin import MediumEditorAdmin
@admin.register(MyModel)
class MyModelAdmin(MediumEditorAdmin, admin.ModelAdmin):
...
mediumeditor_fields = ('my_text_field', )
...
```
### Forms
1. Override the Widget for the field
```
from mediumeditor.widgets import MediumEditorTextarea
class MyForm(forms.ModelForm):
...
class Meta:
model = MyModel
widgets = {
'my_text_field': MediumEditorTextarea(),
}
```
2. In the ```<head>``` of the template
```
{{ form.media }}
```
### Settings
Optionaly change theme or change medium editor options in your settings.py
```
# Theme options `default`, `roman`, `mani`, `flat`, `bootstrap`, `tim`, `beagle`
MEDIUM_EDITOR_THEME = 'beagle' # `default` is defualt theme
MEDIUM_EDITOR_OPTIONS = {..}
```
[Available Options](https://github.com/yabwe/medium-editor/blob/master/OPTIONS.md)
Example:
```
MEDIUM_EDITOR_THEME = 'bootstrap'
MEDIUM_EDITOR_OPTIONS = {
'toolbar': {
'static': True,
'buttons': [
'bold',
'italic',
'underline',
'strikethrough',
'subscript',
'superscript',
'h1',
'h2',
'h3',
'h4',
'h5',
'h6',
]
},
'paste': {
'forcePlainText': True,
'cleanPastedHTML': False,
'cleanReplacements': [],
'cleanAttrs': ['class', 'style', 'dir'],
'cleanTags': ['meta']
}
}
```
## Contributing
[Take out some bugs](https://github.com/g3rd/django-mediumeditor/issues)
[Report issues or feature requests](https://github.com/g3rd/django-mediumeditor/issues)
## License
MIT: https://github.com/g3rd/django-mediumeditor/blob/master/LICENSE
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-mediumeditor-1.0.0.tar.gz.
File metadata
- Download URL: django-mediumeditor-1.0.0.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e71c27bf4797ab48c4948a50ff75d8e5c96e09150588cadafa587aca30e1ec87 |
|
| MD5 | 83bd1607130ed4bf0546ec9282595657 |
|
| BLAKE2b-256 | cae4bc6150e9e63b7a4155913bfa592e3a0ef331561d9e790058ab21a4cbbac9 |
File details
Details for the file django_mediumeditor-1.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: django_mediumeditor-1.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 775d53988c05dc9a625137fed832fb43125071874fa85470b886d3b06effb810 |
|
| MD5 | 6e9c1b9fac1898a5da140ee11bff29db |
|
| BLAKE2b-256 | 1849dc172f72d87286cd3c3ad548c0dfacd08242b86e8cf776b9ca1e66cb764e |
