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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 2Python 3

File details

Details for the file django_editormd-0.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_editormd-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1144d01e4ae2a9285044748f69e42f2f00ee584f2dc94cf06b8ef75ef173ce47
MD5 ac51298c8547887802255fc26acfc585
BLAKE2b-256 46df3706dec9fab59e406e60b925e0c11ff0cad81c099a6c28a774c77a35d2bd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page