Skip to main content

django-editormd package helps integrate editor.md with Django.

Project description

# Django Editor md

>django-editormd package helps integrate [editor.md](https://github.com/pandao/editor.md) with Django.

## Getting started

Install the package:

`pip install django-editormd`


Add `editormd` to INSTALLED_APPS in `settings.py`.


## Usage


1. Usage in models

```python
from editormd.models import EditorMdField


class Page(models.Model):
content_editormd1 = EditorMdField()
```

2. OR Usage in forms

```python
from editormd.fields import EditorMdFormField


class PageForm(forms.ModelForm):
content_editormd1 = EditorMdFormField()
content_editormd2 = EditorMdFormField()
content_editormd3 = EditorMdFormField()

class Meta:
model = Page
fields = '__all__'


@admin.register(Page)
class PageAdmin(admin.ModelAdmin):
form = PageForm
```

## Settings

You can use the following settings in `settings.py`.

- EDITORMD_UPLOAD_TO
set your upload path

- EDITORMD_WATERMARK
default is false, if set True, you should set `EDITORMD_WATERMARK_TEXT='some string'`

- EDITORMD_UPLOAD_SUFFIX
If you use `django-qiniu-storage`, maybe you will use watermark suffix.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Built Distribution

django_editormd-0.3.0-py2.py3-none-any.whl (1.7 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page