update readme docs template

agusmakmun · agusmakmun · commit 1981e6a0ca0a · 2020-09-16T06:26:26.000+07:00
diff --git a/README.rst b/README.rst
@@ -172,11 +172,11 @@ to get ``IMGUR_CLIENT_ID`` and ``IMGUR_API_KEY``.
     MARTOR_MARKDOWN_BASE_EMOJI_URL = 'https://github.githubassets.com/images/icons/emoji/'                  # default from github
     MARTOR_MARKDOWN_BASE_MENTION_URL = 'https://python.web.id/author/'                                      # please change this to your domain
 
-    # If you need to use your own themed semantic ui dependency
+    # If you need to use your own themed "bootstrap" or "semantic ui" dependency
     # replace the values with the file in your static files dir
     MARTOR_ALTERNATIVE_JS_FILE_THEME = "semantic-themed/semantic.min.js"   # default None
     MARTOR_ALTERNATIVE_CSS_FILE_THEME = "semantic-themed/semantic.min.css" # default None
-    MARTOR_ALTERNATIVE_JQUERY_JS_FILE = "jquery/dist/jquery.js"            # default None
+    MARTOR_ALTERNATIVE_JQUERY_JS_FILE = "jquery/dist/jquery.min.js"        # default None
 
 Check this setting is not set else csrf will not be sent over ajax calls:
 
@@ -229,7 +229,7 @@ Usage
     admin.site.register(YourModel, YourModelAdmin)
 
 
-**Template**
+**Template Renderer**
 
 Simply safely parse markdown content as html ouput by loading templatetags from ``martor/templatetags/martortags.py``.
 
@@ -242,6 +242,85 @@ Simply safely parse markdown content as html ouput by loading templatetags from
     {{ post.description|safe_markdown }}
 
 
+Don't miss to include the required css & js files before use.
+You can take a look at this folder `martor_demo/app/templates`_ for more details.
+The below example is a one of the way to implement it when you choose the ``MARTOR_THEME = 'bootstrap'``:
+
+::
+
+    {% extends "bootstrap/base.html" %}
+    {% load static %}
+    {% load martortags %}
+
+    {% block css %}
+      <link href="{% static 'plugins/css/ace.min.css' %}" type="text/css" media="all" rel="stylesheet" />
+      <link href="{% static 'martor/css/martor.bootstrap.min.css' %}" type="text/css" media="all" rel="stylesheet" />
+    {% endblock %}
+
+    {% block content %}
+      <div class="martor-preview">
+        <h1>Title: {{ post.title }}</h1>
+        <p><b>Description:</b></p>
+        <hr />
+        {{ post.description|safe_markdown }}
+      </div>
+    {% endblock %}
+
+    {% block js %}
+      <script type="text/javascript" src="{% static 'plugins/js/highlight.min.js' %}"></script>
+      <script>
+        $('.martor-preview pre').each(function(i, block){
+            hljs.highlightBlock(block);
+        });
+      </script>
+    {% endblock %}
+
+
+**Template Editor Form**
+
+Different with *Template Renderer*, the *Template Editor Form* have more css & javascript dependencies.
+
+::
+
+    {% extends "bootstrap/base.html" %}
+    {% load static %}
+
+    {% block css %}
+      <link href="{% static 'plugins/css/ace.min.css' %}" type="text/css" media="all" rel="stylesheet" />
+      <link href="{% static 'plugins/css/resizable.min.css' %}" type="text/css" media="all" rel="stylesheet" />
+      <link href="{% static 'martor/css/martor.bootstrap.min.css' %}" type="text/css" media="all" rel="stylesheet" />
+    {% endblock %}
+
+    {% block content %}
+      <form class="form" method="post">{% csrf_token %}
+        <div class="form-group">
+          {{ form.title }}
+        </div>
+        <div class="form-group">
+          {{ form.description }}
+        </div>
+        <div class="form-group">
+          <button class="btn btn-success">
+            <i class="save icon"></i> Save Post
+          </button>
+        </div>
+      </form>
+    {% endblock %}
+
+    {% block js %}
+      <script type="text/javascript" src="{% static 'plugins/js/ace.js' %}"></script>
+      <script type="text/javascript" src="{% static 'plugins/js/mode-markdown.js' %}"></script>
+      <script type="text/javascript" src="{% static 'plugins/js/ext-language_tools.js' %}"></script>
+      <script type="text/javascript" src="{% static 'plugins/js/theme-github.js' %}"></script>
+      <script type="text/javascript" src="{% static 'plugins/js/typo.js' %}"></script>
+      <script type="text/javascript" src="{% static 'plugins/js/spellcheck.js' %}"></script>
+      <script type="text/javascript" src="{% static 'plugins/js/highlight.min.js' %}"></script>
+      <script type="text/javascript" src="{% static 'plugins/js/resizable.min.js' %}"></script>
+      <script type="text/javascript" src="{% static 'plugins/js/emojis.min.js' %}"></script>
+      <script type="text/javascript" src="{% static 'martor/js/martor.bootstrap.min.js' %}"></script>
+    {% endblock %}
+
+
 Custom Uploader
 -----------------
 
@@ -285,5 +364,6 @@ Notes
 .. _Python Markdown: https://github.com/waylan/Python-Markdown
 .. _Online reStructuredText editor: http://rst.ninjs.org
 .. _WIKI: https://github.com/agusmakmun/django-markdown-editor/wiki
+.. _martor_demo/app/templates: https://github.com/agusmakmun/django-markdown-editor/tree/master/martor_demo/app/templates
 .. _fixed this issue: https://github.com/agusmakmun/django-markdown-editor/issues/3
 .. _custom uploader: https://github.com/agusmakmun/django-markdown-editor/wiki
diff --git a/martor_demo/app/admin.py b/martor_demo/app/admin.py
@@ -14,4 +14,5 @@ class PostAdmin(admin.ModelAdmin):
         models.TextField: {'widget': AdminMartorWidget},
     }
 
+
 admin.site.register(Post, PostAdmin)
diff --git a/martor_demo/app/templates/bootstrap/test_markdownify.html b/martor_demo/app/templates/bootstrap/test_markdownify.html
@@ -20,7 +20,7 @@ <h1>Title: {{ post.title }}</h1>
 {% block js %}
   <script type="text/javascript" src="{% static 'plugins/js/highlight.min.js' %}"></script>
   <script>
-    $('pre').each(function(i, block){
+    $('.martor-preview pre').each(function(i, block){
         hljs.highlightBlock(block);
     });
   </script>
diff --git a/martor_demo/app/templates/semantic/test_markdownify.html b/martor_demo/app/templates/semantic/test_markdownify.html
@@ -22,7 +22,7 @@ <h1>Title: {{ post.title }}</h1>
 {% block js %}
   <script type="text/javascript" src="{% static 'plugins/js/highlight.min.js' %}"></script>
   <script>
-    $('pre').each(function(i, block){
+    $('.martor-preview pre').each(function(i, block){
         hljs.highlightBlock(block);
     });
   </script>
diff --git a/martor_demo/manage.py b/martor_demo/manage.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
 import os
 import sys
 
-if __name__ == "__main__":
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "martor_demo.settings")
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'martor_demo.settings')
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -13,3 +16,7 @@
             "forget to activate a virtual environment?"
         ) from exc
     execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/martor_demo/martor_demo/asgi.py b/martor_demo/martor_demo/asgi.py
@@ -0,0 +1,16 @@
+"""
+ASGI config for martor_demo project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'martor_demo.settings')
+
+application = get_asgi_application()
diff --git a/martor_demo/martor_demo/settings.py b/martor_demo/martor_demo/settings.py
@@ -1,27 +1,28 @@
 """
 Django settings for martor_demo project.
 
-Generated by 'django-admin startproject' using Django 3.0.2.
+Generated by 'django-admin startproject' using Django 3.1.1.
 
 For more information on this file, see
-https://docs.djangoproject.com/en/3.0/topics/settings/
+https://docs.djangoproject.com/en/3.1/topics/settings/
 
 For the full list of settings and their values, see
-https://docs.djangoproject.com/en/3.0/ref/settings/
+https://docs.djangoproject.com/en/3.1/ref/settings/
 """
 
 import os
 import tempfile
+from pathlib import Path
 
-# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
-BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
 
 
 # Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/3.0/howto/deployment/checklist/
+# See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = '93fs*#h77*vj&2#2f+!y=kifg0s&63768398a(kx126itq(*6r'
+SECRET_KEY = '+1zhx_fpkkyj&z+3n!63fx0)og)@h5^7qyr8e0s%c@p8_&t&+l'
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
@@ -91,18 +92,18 @@
 
 
 # Database
-# https://docs.djangoproject.com/en/3.0/ref/settings/#databases
+# https://docs.djangoproject.com/en/3.1/ref/settings/#databases
 
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+        'NAME': BASE_DIR / 'db.sqlite3',
     }
 }
 
 
 # Password validation
-# https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators
+# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
     {
@@ -121,7 +122,7 @@
 
 
 # Internationalization
-# https://docs.djangoproject.com/en/3.0/topics/i18n/
+# https://docs.djangoproject.com/en/3.1/topics/i18n/
 
 LANGUAGE_CODE = 'en-us'
 
@@ -135,7 +136,8 @@
 
 
 # Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/3.0/howto/static-files/
+# https://docs.djangoproject.com/en/3.1/howto/static-files/
+
 
 STATIC_URL = '/static/'
 MEDIA_URL = '/media/'
diff --git a/martor_demo/martor_demo/urls.py b/martor_demo/martor_demo/urls.py
@@ -1,7 +1,7 @@
 """martor_demo URL Configuration
 
 The `urlpatterns` list routes URLs to views. For more information please see:
-    https://docs.djangoproject.com/en/3.0/topics/http/urls/
+    https://docs.djangoproject.com/en/3.1/topics/http/urls/
 Examples:
 Function views
     1. Add an import:  from my_app import views
diff --git a/martor_demo/martor_demo/wsgi.py b/martor_demo/martor_demo/wsgi.py
@@ -4,13 +4,13 @@
 It exposes the WSGI callable as a module-level variable named ``application``.
 
 For more information on this file, see
-https://docs.djangoproject.com/en/3.0/howto/deployment/wsgi/
+https://docs.djangoproject.com/en/3.1/howto/deployment/wsgi/
 """
 
 import os
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "martor_demo.settings")
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'martor_demo.settings')
 
 application = get_wsgi_application()

Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,5 @@ class PostAdmin(admin.ModelAdmin):`
`14`	`14`	`models.TextField: {'widget': AdminMartorWidget},`
`15`	`15`	`}`
`16`	`16`
	`17`	`+`
`17`	`18`	`admin.site.register(Post, PostAdmin)`