README.md

Author: 2ik

README.md

@@ -1,2 +1,92 @@
 # Editor.js for Django
-Django plugin for using Editor.js
+
+Django plugin for using [Editor.js](https://editorjs.io/)
+
+> This plugin works fine with JSONField in Django >= 3.1
+
+## Installation
+
+```bash
+pip install django-editorjs
+```
+
+Add django_editorjs to INSTALLED_APPS in settings.py for your project:
+```python
+# settings.py
+INSTALLED_APPS = [
+    ...
+    'django_editorjs',
+]
+```
+
+## Usage
+
+Add code in your model
+```python
+# models.py
+from django.db import models
+from django_editorjs import EditorJsJSONField, EditorJsTextField  # import
+
+
+class Post(models.Model):
+    body_default = models.TextField()
+    body_editorjs = EditorJsJSONField()  # Django >= 3.1
+    body_editorjs_text = EditorJsTextField()  # Django <= 3.0
+
+```
+
+Or add custom Editor.js plugins and configs ([List plugins](https://github.com/editor-js/awesome-editorjs))
+
+```python
+# models.py
+from django.db import models
+from django_editorjs import EditorJsJSONField, EditorJsTextField  # import
+
+
+class Post(models.Model):
+    body_custom = EditorJsJSONField(
+        plugins=[
+            "@editorjs/image",
+            "@editorjs/header",
+            "editorjs-github-gist-plugin",
+            "@editorjs/code@2.6.0",  # version allowed :)
+            "@editorjs/list@latest",
+            "@editorjs/inline-code",
+            "@editorjs/table",
+        ],
+        tools={
+            "Image": {
+                "config": {
+                    "endpoints": {
+                        # Your custom backend file uploader endpoint
+                        "byFile": "/editorjs/image_upload/"
+                    }
+                }
+            }
+        },
+        null=True,
+        blank=True
+    )
+
+```
+
+If you want to upload images to the editor then add django_editorjs.urls to urls.py for your project:
+```python
+# urls.py
+from django.contrib import admin
+from django.urls import path, include
+from django.conf import settings
+from django.conf.urls.static import static
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+    path('editorjs/', include('django_editorjs.urls')),
+] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
+```
+
+See an example of how you can work with the plugin [here](https://github.com/2ik/django-editorjs/blob/main/example)
+
+
+## Support and updates
+
+Use github issues https://github.com/2ik/django-editorjs/issues

django_editorjs/fields.py

@@ -8,12 +8,14 @@
 
 try:
     # pylint: disable=ungrouped-imports
-    from django.db.models import JSONField
+    from django.db.models import JSONField  # Django >= 3.1
 except ImportError:
     HAS_JSONFIELD = False
 else:
     HAS_JSONFIELD = True
 
+__all__ = ['EditorJsTextField', 'EditorJsJSONField']
+
 
 class FieldMixin(Field):
     def get_internal_type(self):

…ango_editorjs/static/django-editorjs.css …/django-editorjs/css/django-editorjs.cssdjango_editorjs/static/django-editorjs.css renamed to django_editorjs/static/admin/2ik/django-editorjs/css/django-editorjs.css django_editorjs/static/django-editorjs.css renamed to django_editorjs/static/admin/2ik/django-editorjs/css/django-editorjs.css

@@ -42,10 +42,10 @@ def media(self):
             js_list.append('https://cdn.jsdelivr.net/combine/npm/' +
                            ',npm/'.join(plugins))
 
-        js_list.append('django-editorjs.js')
+        js_list.append('admin/2ik/django-editorjs/js/django-editorjs.js')
 
         return Media(
-            css={'all': ['django-editorjs.css']},
+            css={'all': ['admin/2ik/django-editorjs/css/django-editorjs.css']},
             js=js_list
         )
 

django_editorjs/static/django-editorjs.js …ik/django-editorjs/js/django-editorjs.jsdjango_editorjs/static/django-editorjs.js renamed to django_editorjs/static/admin/2ik/django-editorjs/js/django-editorjs.js django_editorjs/static/django-editorjs.js renamed to django_editorjs/static/admin/2ik/django-editorjs/js/django-editorjs.js

@@ -132,5 +132,5 @@
 
 STATIC_URL = '/static/'
 MEDIA_URL = "/media/"
-STATIC_URL = f'{BASE_DIR}/static/'
+STATIC_ROOT = f'{BASE_DIR}/static/'
 MEDIA_ROOT = f'{BASE_DIR}/media/'