# A markdown editor (with preview) for Django
Use a simple markdown editor https://github.com/Ionaru/easy-markdown-editor in django forms. This project is inspired by https://github.com/sparksuite/simplemde-markdown-editor and https://github.com/douglasmiranda/django-wysiwyg-redactor/.
***Note that [SimpleMDE](https://github.com/sparksuite/simplemde-markdown-editor) is no longer in development, and has been forked to create [EasyMDE](https://github.com/Ionaru/easy-markdown-editor), which is in active development as of mid-2024.***
# Getting started
* install django-easymde
```
pip install django-easymde
```
* add 'easymde' to INSTALLED_APPS.
```python
INSTALLED_APPS = (
# ...
'easymde',
# ...
)
```
# Using field in models
```python
from django.db import models
from easymde.fields import EasyMDEField
class Entry(models.Model):
title = models.CharField(max_length=250, verbose_name=u'Title')
content = EasyMDEField(verbose_name=u'mardown content')
```
Note: The widget `EasyMDEWidget` can also be used in forms on existing fields.
# EasyMDE options
EasyMDE options can be set in `settings.py`:
```python
EASYMDE_OPTIONS = {
'placeholder': 'Type here...',
'status': False,
'autosave': {
'enabled': True
}
}
```
***For the autosave option, this plugin will generate uniqueId with python's uuid.uuid4 automatically.***
Right now, this plugin supports [EasyMDE Configurations](https://github.com/Ionaru/easy-markdown-editor#configuration), but only the static ones(no support for javascript configurations such as ```previewRender```)
# Get EasyMDE instance from DOM
After EasyMDE is initialized, a EasyMDE instance can be retrieved from the DOM element:
```javascript
$('.easymde-box')[0].EasyMDE
```
Raw data
{
"_id": null,
"home_page": "https://github.com/WPI-LNL/django-easymde",
"name": "django-easymde",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "django, admin, wysiwyg, markdown, editor, easymde",
"author": "Benjamin Antupit",
"author_email": "b@antupit.com",
"download_url": "https://files.pythonhosted.org/packages/d4/54/abbd9ce6107405a87c57e6a2f664241da6d7fcf4e8e326b4c15d896a0e01/django_easymde-1.0.4.tar.gz",
"platform": null,
"description": "# A markdown editor (with preview) for Django\nUse a simple markdown editor https://github.com/Ionaru/easy-markdown-editor in django forms. This project is inspired by https://github.com/sparksuite/simplemde-markdown-editor and https://github.com/douglasmiranda/django-wysiwyg-redactor/.\n\n***Note that [SimpleMDE](https://github.com/sparksuite/simplemde-markdown-editor) is no longer in development, and has been forked to create [EasyMDE](https://github.com/Ionaru/easy-markdown-editor), which is in active development as of mid-2024.***\n\n# Getting started\n* install django-easymde\n```\npip install django-easymde\n```\n\n* add 'easymde' to INSTALLED_APPS.\n\n```python\nINSTALLED_APPS = (\n # ...\n 'easymde',\n # ...\n)\n```\n\n# Using field in models\n```python\nfrom django.db import models\nfrom easymde.fields import EasyMDEField\n\nclass Entry(models.Model):\n title = models.CharField(max_length=250, verbose_name=u'Title')\n content = EasyMDEField(verbose_name=u'mardown content')\n```\n\nNote: The widget `EasyMDEWidget` can also be used in forms on existing fields.\n\n# EasyMDE options\nEasyMDE options can be set in `settings.py`:\n\n```python\nEASYMDE_OPTIONS = {\n 'placeholder': 'Type here...',\n 'status': False,\n 'autosave': {\n 'enabled': True\n }\n}\n```\n\n***For the autosave option, this plugin will generate uniqueId with python's uuid.uuid4 automatically.***\n\nRight now, this plugin supports [EasyMDE Configurations](https://github.com/Ionaru/easy-markdown-editor#configuration), but only the static ones(no support for javascript configurations such as ```previewRender```)\n\n# Get EasyMDE instance from DOM\n\nAfter EasyMDE is initialized, a EasyMDE instance can be retrieved from the DOM element:\n\n```javascript\n$('.easymde-box')[0].EasyMDE\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "django-easymde is a WYSIWYG markdown editor for Django",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/WPI-LNL/django-easymde"
},
"split_keywords": [
"django",
" admin",
" wysiwyg",
" markdown",
" editor",
" easymde"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "267b0981dbbc659c2cd3281a24e0daf1181dae832e73c5039933ac46e9fbfe43",
"md5": "39095f9a761da99c3ced4b1c108d409a",
"sha256": "5b2fd94953b76cb69aebd5d6169056084188e079609bee1300174ad54cfa346a"
},
"downloads": -1,
"filename": "django_easymde-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39095f9a761da99c3ced4b1c108d409a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 114786,
"upload_time": "2024-07-29T04:32:41",
"upload_time_iso_8601": "2024-07-29T04:32:41.661354Z",
"url": "https://files.pythonhosted.org/packages/26/7b/0981dbbc659c2cd3281a24e0daf1181dae832e73c5039933ac46e9fbfe43/django_easymde-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d454abbd9ce6107405a87c57e6a2f664241da6d7fcf4e8e326b4c15d896a0e01",
"md5": "abe9ae59ac5c5e4cebc189802c1901d1",
"sha256": "0690902bde591461138e174e47f58363f1f7b7fb637ebae7401e7a6449177e26"
},
"downloads": -1,
"filename": "django_easymde-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "abe9ae59ac5c5e4cebc189802c1901d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 113862,
"upload_time": "2024-07-29T04:32:43",
"upload_time_iso_8601": "2024-07-29T04:32:43.080324Z",
"url": "https://files.pythonhosted.org/packages/d4/54/abbd9ce6107405a87c57e6a2f664241da6d7fcf4e8e326b4c15d896a0e01/django_easymde-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 04:32:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WPI-LNL",
"github_project": "django-easymde",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-easymde"
}
JSON
