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.9
* Python 3.4
## 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
**NOTE:** This is untested
1. Override the Widget for the field
```
from mediumeditor.widget import MediumEditorTextarea
class MyForm(forms.ModelForm):
...
class Meta:
model = MyModel
widgets = {
'my_text_field': MediumEditorTextarea(),
}
```
2. In the ```<head>``` of the template
```
{{ form.media }}
```
## Contributing
[Take out some bugs](https://github.com/g3rd/django-mediumeditor/issues)
[Report issues or feature requests](https://github.com/g3rd/django-mediumeditor/issues)
## Todo
Since this is a very new project,
- [ ] Documentation
- [ ] Clean-up Django admin display
- Toolbar style
- Anchor configuration toolbar
- Bold to use ```<strong>```
- Italic to use ```<em>```
- Inline styles do not inherit Django Admin (see H2 and unordered lists)
- [ ] Expand Django support to 1.8
- [ ] Expand Python support to 2
- [ ] Tests!
- [ ] Configure the toolbar - globally
- [ ] Configure the toolbar - per form
- [ ] Configure the toolbar - per field
## 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.9
* Python 3.4
## 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
**NOTE:** This is untested
1. Override the Widget for the field
```
from mediumeditor.widget import MediumEditorTextarea
class MyForm(forms.ModelForm):
...
class Meta:
model = MyModel
widgets = {
'my_text_field': MediumEditorTextarea(),
}
```
2. In the ```<head>``` of the template
```
{{ form.media }}
```
## Contributing
[Take out some bugs](https://github.com/g3rd/django-mediumeditor/issues)
[Report issues or feature requests](https://github.com/g3rd/django-mediumeditor/issues)
## Todo
Since this is a very new project,
- [ ] Documentation
- [ ] Clean-up Django admin display
- Toolbar style
- Anchor configuration toolbar
- Bold to use ```<strong>```
- Italic to use ```<em>```
- Inline styles do not inherit Django Admin (see H2 and unordered lists)
- [ ] Expand Django support to 1.8
- [ ] Expand Python support to 2
- [ ] Tests!
- [ ] Configure the toolbar - globally
- [ ] Configure the toolbar - per form
- [ ] Configure the toolbar - per field
## 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
Close
Hashes for django-mediumeditor-0.1.3.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1756100dfd88a2d9ea8df19cf4479725d89ae7564be3670f8c230392465fc2dc |
|
| MD5 | 7e87ba63550dd8cc49c4bb999cfcec36 |
|
| BLAKE2b-256 | 12819c34ed0283e7133f3fde2c16bb4d38f1763239e575cebeb284eaa2cbae21 |
