4 |
24 |
25 |
46 |
47 |
48 | {% include 'martor/bootstrap/guide.html' %}
49 | {% include 'martor/bootstrap/emoji.html' %}
50 | hello summonagus, 18 | i mentioned you!
' 19 | >>> 20 | """ 21 | 22 | MENTION_RE = r"(?>> import markdown 10 | >>> md = markdown.Markdown(extensions=['urlize']) 11 | 12 | >>> md.convert('http://example.com/') 13 | u'' 14 | 15 | >>> md.convert('go to http://example.com') 16 | u'go to http://example.com
' 17 | 18 | >>> md.convert('example.com') 19 | u'' 20 | 21 | >>> md.convert('example.net') 22 | u'' 23 | 24 | >>> md.convert('www.example.us') 25 | u'' 26 | 27 | >>> md.convert('(www.example.us/path/?name=val)') 28 | u'(www.example.us/path/?name=val)
' 29 | 30 | >>> md.convert('go togo to http://example.com now!
' 32 | 33 | Negative examples: 34 | 35 | >>> md.convert('del.icio.us') 36 | u'del.icio.us
' 37 | 38 | """ 39 | 40 | from xml.etree import ElementTree 41 | 42 | import markdown 43 | 44 | # Global Vars 45 | URLIZE_RE = "(%s)" % "|".join( 46 | [ 47 | r"<(?:f|ht)tps?://[^>]*>", 48 | r"\b(?:f|ht)tps?://[^)<>\s]+[^.,)<>\s]", 49 | r"\bwww\.[^)<>\s]+[^.,)<>\s]", 50 | r"[^(<\s]+\.(?:com|net|org)\b", 51 | ] 52 | ) 53 | 54 | 55 | class UrlizePattern(markdown.inlinepatterns.Pattern): 56 | """Return a link Element given an autolink (`http://example/com`).""" 57 | 58 | def handleMatch(self, m): 59 | url = m.group(2) 60 | 61 | if url.startswith("<"): 62 | url = url[1:-1] 63 | 64 | text = url 65 | 66 | if url.split("://")[0] not in ("http", "https", "ftp"): 67 | if "@" in url and "/" not in url: 68 | url = "mailto:" + url 69 | else: 70 | url = "http://" + url 71 | 72 | el = ElementTree.Element("a") 73 | el.set("href", url) 74 | el.text = markdown.util.AtomicString(text) 75 | return el 76 | 77 | 78 | class UrlizeExtension(markdown.Extension): 79 | """Urlize Extension for Python-Markdown.""" 80 | 81 | def extendMarkdown(self, md: markdown.core.Markdown, *args): 82 | """Replace autolink with UrlizePattern""" 83 | md.inlinePatterns.register(UrlizePattern(URLIZE_RE, md), "autolink", 14) 84 | 85 | 86 | def makeExtension(*args, **kwargs): 87 | return UrlizeExtension(*args, **kwargs) 88 | 89 | 90 | if __name__ == "__main__": 91 | import doctest 92 | 93 | doctest.testmod() 94 | -------------------------------------------------------------------------------- /martor/fields.py: -------------------------------------------------------------------------------- 1 | from django import forms 2 | 3 | from .settings import MARTOR_ENABLE_LABEL 4 | from .widgets import MartorWidget 5 | 6 | 7 | class MartorFormField(forms.CharField): 8 | def __init__(self, *args, **kwargs): 9 | # to setup the editor without label 10 | if not MARTOR_ENABLE_LABEL: 11 | kwargs["label"] = "" 12 | 13 | super().__init__(*args, **kwargs) 14 | 15 | if not issubclass(self.widget.__class__, MartorWidget): 16 | self.widget = MartorWidget() 17 | -------------------------------------------------------------------------------- /martor/locale/en/LC_MESSAGES/django.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/5dbc9f1f7e10931472a7309b237c66c2ecb33045/martor/locale/en/LC_MESSAGES/django.mo -------------------------------------------------------------------------------- /martor/locale/en/LC_MESSAGES/django.po: -------------------------------------------------------------------------------- 1 | # SOME DESCRIPTIVE TITLE. 2 | # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER 3 | # This file is distributed under the same license as the PACKAGE package. 4 | # FIRST AUTHOR
3 |
51 |
--------------------------------------------------------------------------------
/martor/templates/martor/bootstrap/emoji.html:
--------------------------------------------------------------------------------
1 | {% load i18n %}
2 |
3 |
29 |
--------------------------------------------------------------------------------
/martor/templates/martor/bootstrap/guide.html:
--------------------------------------------------------------------------------
1 | {% load i18n static %}
2 |
3 |
208 |
--------------------------------------------------------------------------------
/martor/templates/martor/semantic/editor.html:
--------------------------------------------------------------------------------
1 | {% load i18n %}
2 |
3 |
25 |
--------------------------------------------------------------------------------
/martor/templates/martor/semantic/emoji.html:
--------------------------------------------------------------------------------
1 | {% load i18n %}
2 |
4 |
9 |
21 |
22 | {% include 'martor/semantic/guide.html' %}
23 | {% include 'martor/semantic/emoji.html' %}
24 |
10 |
13 |
14 | {{ martor }}
15 |
16 |
17 |
18 |
20 | {% trans "Nothing to preview" %}
19 |
3 |
4 |
15 |
--------------------------------------------------------------------------------
/martor/templates/martor/semantic/guide.html:
--------------------------------------------------------------------------------
1 | {% load i18n static %}
2 | {% trans "Select Emoji to Insert" %}
5 |
6 |
14 |
7 |
11 |
8 |
10 | {% trans "Preparing emojis..." %}
9 |
12 |
13 |
3 |
4 |
193 |
--------------------------------------------------------------------------------
/martor/templates/martor/semantic/toolbar.html:
--------------------------------------------------------------------------------
1 | {% load i18n %}
2 |
105 |
--------------------------------------------------------------------------------
/martor/templatetags/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/5dbc9f1f7e10931472a7309b237c66c2ecb33045/martor/templatetags/__init__.py
--------------------------------------------------------------------------------
/martor/templatetags/martortags.py:
--------------------------------------------------------------------------------
1 | from django import template
2 | from django.utils.safestring import mark_safe
3 |
4 | from ..utils import markdownify
5 |
6 | register = template.Library()
7 |
8 |
9 | @register.filter
10 | def safe_markdown(markdown_text):
11 | """
12 | Safe the markdown text as html output.
13 |
14 | Usage:
15 | {% load martortags %}
16 | {{ markdown_text|safe_markdown }}
17 |
18 | Example:
19 | {{ post.description|safe_markdown }}
20 | """
21 | return mark_safe(markdownify(markdown_text))
22 |
--------------------------------------------------------------------------------
/martor/tests/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/5dbc9f1f7e10931472a7309b237c66c2ecb33045/martor/tests/__init__.py
--------------------------------------------------------------------------------
/martor/tests/models.py:
--------------------------------------------------------------------------------
1 | from django.db import models
2 |
3 | from martor.models import MartorField
4 |
5 |
6 | class Post(models.Model):
7 | description = MartorField()
8 | wiki = MartorField()
9 |
10 | class Meta:
11 | app_label = "Post"
12 |
--------------------------------------------------------------------------------
/martor/tests/templates/test_form_view.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | {% trans "Markdown Guide" %}
5 |
6 |
7 |
10 |
11 |
14 |
15 |
16 |
191 |
192 | {% blocktrans with repo_url='https://github.com/agusmakmun/django-markdown-editor' %}Copyright © Martor{% endblocktrans %}
9 |{% blocktrans with doc_url='http://commonmark.org/help/' %}This editor is powered by Markdown. For full 12 | documentation, click here.{% endblocktrans %}
13 || {% trans "Code" %} | 18 |{% trans "Or" %} | 19 |Linux/Windows | 20 |Mac OS | 21 |{% trans "... to Get" %} | 22 |
|---|---|---|---|---|
| :emoji_name: | 28 |— | 29 |— | 30 |— | 31 | |
32 |
| @[username] | 38 |— | 39 |Ctrl+M | 40 |Command+M | 41 |@username | 42 |
| 48 | | ||||
| *Italic* | 53 |_Italic_ | 54 |Ctrl+I | 55 |Command+I | 56 |Italic | 57 |
| **Bold** | 60 |__Bold__ | 61 |Ctrl+B | 62 |Command+B | 63 |Bold | 64 |
| ++Underscores++ | 67 |— | 68 |Ctrl+Shift+U | 69 |Command+Shift+U | 70 |Underscores | 71 |
| ~~Strikethrough~~ | 74 |— | 75 |Ctrl+Shift+S | 76 |Command+Shift+S | 77 ||
| # Heading 1 | 81 |Heading 1 ========= |
82 | Ctrl+Alt+1 | 83 |Command+Option+1 | 84 |
85 | Heading 186 | |
87 |
| ## Heading 2 | 90 |Heading 2 ----------- |
91 | Ctrl+Alt+2 | 92 |Command+Option+2 | 93 |
94 | Heading 295 | |
96 |
| [Link](http://a.com) | 99 |[Link][1] ⁝ [1]: http://b.org |
100 | Ctrl+L | 101 |Command+L | 102 |Link | 103 |
|  | 106 |![Image][1] ⁝ [1]: http://url/b.jpg |
107 | Ctrl+Shift+I | 108 |Command+Option+I | 109 | |
110 |
| > Blockquote | 113 |— | 114 |Ctrl+Q | 115 |Command+Shift+K | 116 |
117 | Blockquote118 | |
119 |
| A paragraph. A paragraph after 1 blank line. |
122 | — | 123 |— | 124 |— | 125 |
126 | A paragraph. 127 |A paragraph after 1 blank line. 128 | |
129 |
|
132 | * List |
134 |
135 | - List |
137 | Ctrl+U | 138 |Command+U | 139 |
140 |
|
146 |
|
149 | 1. One |
151 |
152 | 1) One |
154 | Ctrl+Shift+O | 155 |Command+Option+O | 156 |
157 |
|
163 |
| Horizontal Rule ----------- |
166 | Horizontal Rule *********** |
167 | Ctrl+H | 168 |Command+H | 169 |Horizontal Rule
170 | 171 | |
172 |
| `Inline code` with backticks | 175 |— | 176 |Ctrl+Alt+C | 177 |Command+Option+C | 178 |Inline code with backticks |
179 |
| ``` def whatever(foo): return foo ``` |
182 | with tab / 4 spaces ....def whatever(foo): .... return foo |
183 | Ctrl+Alt+P | 184 |Command+Option+P | 185 |
186 | def whatever(foo):187 | |
188 |
8 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/martor/tests/tests.py:
--------------------------------------------------------------------------------
1 | import sys
2 | from importlib import reload
3 |
4 | from django.contrib.auth.models import User
5 | from django.core.signals import setting_changed
6 | from django.test import TestCase, override_settings
7 | from django.urls import clear_url_caches, resolve, reverse
8 |
9 | from martor.utils import markdownify
10 | from martor.views import markdown_imgur_uploader, markdown_search_user, markdownfy_view
11 |
12 |
13 | class SimpleTest(TestCase):
14 | def _on_settings_changed(self, sender, **kwargs):
15 | # Reload settings.py and urls.py when @override_settings is called
16 | clear_url_caches()
17 | reload(sys.modules["martor.settings"])
18 | reload(sys.modules["martor.urls"])
19 | reload(sys.modules["martor.tests.urls"])
20 |
21 | def setUp(self):
22 | self.user_password = "TestEgg@1234"
23 | self.user = User.objects.create_user(
24 | username="user1",
25 | email="user1@mail.com",
26 | password=self.user_password,
27 | )
28 | self.client.login(
29 | username=self.user.username,
30 | password=self.user_password,
31 | )
32 |
33 | setting_changed.connect(self._on_settings_changed)
34 |
35 | def tearDown(self):
36 | setting_changed.disconnect(self._on_settings_changed)
37 |
38 | def test_form(self):
39 | response = self.client.get("/test-form-view/")
40 | self.assertEqual(response.status_code, 200)
41 | self.assertTemplateUsed("test_form_view.html")
42 | self.assertContains(response, "main-martor-description")
43 | self.assertContains(response, "main-martor-wiki")
44 |
45 | @override_settings(
46 | MARTOR_ENABLE_CONFIGS={
47 | "emoji": "true", # enable/disable emoji icons.
48 | "imgur": "true", # enable/disable imgur/custom uploader.
49 | "mention": "true", # enable/disable mention
50 | "jquery": "true", # include/revoke jquery (require for admin django) # noqa: E501
51 | "living": "false", # enable/disable live updates in preview
52 | "spellcheck": "false", # enable/disable spellcheck in form textareas # noqa: E501
53 | "hljs": "true", # enable/disable hljs highlighting in preview
54 | },
55 | MARTOR_MARKDOWN_BASE_EMOJI_URL="https://github.githubassets.com/images/icons/emoji/",
56 | MARTOR_MARKDOWN_BASE_MENTION_URL="https://python.web.id/author/",
57 | )
58 | def test_markdownify(self):
59 | # Heading
60 | response = self.client.post(
61 | "/martor/markdownify/",
62 | {"content": "# Hello world!"},
63 | )
64 | self.assertEqual(response.status_code, 200)
65 | self.assertEqual(
66 | response.content.decode("utf-8"), "
9 |
24 | Hello world!
" 67 | ) # noqa: E501 68 | 69 | # Link 70 | response = self.client.post( 71 | "/martor/markdownify/", 72 | {"content": "[python](https://python.web.id)"}, 73 | ) 74 | self.assertEqual(response.status_code, 200) 75 | self.assertEqual( 76 | response.content.decode("utf-8"), 77 | '', 78 | ) # noqa: E501 79 | 80 | # Image 81 | response = self.client.post( 82 | "/martor/markdownify/", 83 | {"content": ""}, 84 | ) 85 | self.assertEqual(response.status_code, 200) 86 | self.assertEqual( 87 | response.content.decode("utf-8"), 88 | '
Advertisement :)
\nh6 Heading
', 124 | ) # noqa: E501 125 | 126 | def test_markdownify_xss_handled(self): 127 | xss_payload_1 = "[aaaa](javascript:alert(1))" 128 | response_1 = markdownify(xss_payload_1) 129 | self.assertEqual(response_1, "") 130 | 131 | xss_payload_2 = '' 132 | response_2 = markdownify(xss_payload_2) 133 | self.assertEqual( 134 | response_2, 'xss)
', # noqa: E501 142 | ) 143 | 144 | def test_urls(self): 145 | with override_settings( 146 | MARTOR_MARKDOWNIFY_URL="test/url", 147 | MARTOR_UPLOAD_URL="test/upload", 148 | MARTOR_SEARCH_USERS_URL="test/search", 149 | ): 150 | found = resolve(reverse("martor_markdownfy")) 151 | self.assertEqual(found.func, markdownfy_view) 152 | 153 | found = resolve(reverse("imgur_uploader")) 154 | self.assertEqual(found.func, markdown_imgur_uploader) 155 | 156 | found = resolve(reverse("search_user_json")) 157 | self.assertEqual(found.func, markdown_search_user) 158 | 159 | 160 | class MarkdownifyTest(TestCase): 161 | def test_markdownify_regular_text(self): 162 | markdown_tuples = [ 163 | ("# Heading Level 1", "Heading Level 1
"), 164 | ("**This is bold text**", "This is bold text
"), 165 | ("*This is italic text*", "This is italic text
"), 166 | ( 167 | "[Link to google](https://google.com)", 168 | '', 169 | ), 170 | ( 171 | "1. List item 1\n2. List item 2\n3. List item 3", 172 | "- \n
- List item 1 \n
- List item 2 \n
- List item 3 \n
[1] - Our Epidemic of Loneliness and Isolation (hhs.gov)
', 200 | ) 201 | 202 | def test_markdownify_not_losing_sentences(self): 203 | markdown_text = "The CDC reports that it was 26.2 per 100,000.[[4]](#ftnt4) In addition, individuals with mental and behavioral health conditions have a higher risk of suicide; rates increased 46 percent from 2000-2020 in non-metro areas.[[5]](#ftnt5)" 204 | 205 | response = markdownify(markdown_text) 206 | # previously, this was 'The CDC reports that it was 26.2 per 100,000.[4]
', dropping the last sentence 207 | self.assertEqual( 208 | response, 209 | 'The CDC reports that it was 26.2 per 100,000.[4] In addition, individuals with mental and behavioral health conditions have a higher risk of suicide; rates increased 46 percent from 2000-2020 in non-metro areas.[5]
', 210 | ) 211 | 212 | def test_markdownify_not_losing_sentences_semicolon(self): 213 | markdown_text = "Citation 4. [footnote 4](#ftnt4) Citation 5. [footnote 5](#ftnt5) Citation 6; [footnote 6](#ftnt6)" 214 | 215 | response = markdownify(markdown_text) 216 | # previously, this was 'Citation 4. footnote 4 Citation 5. footnote 5
' 217 | self.assertEqual( 218 | response, 219 | 'Citation 4. footnote 4 Citation 5. footnote 5 Citation 6; footnote 6
', 220 | ) 221 | 222 | def test_markdownify_not_losing_sentences_colon(self): 223 | markdown_text = "Citation 4. [footnote 4](#ftnt4) Citation 5. [footnote 5](#ftnt5) Citation 6: [footnote 6](#ftnt6)" 224 | 225 | response = markdownify(markdown_text) 226 | # previously, this was 'Citation 4. footnote 4 Citation 5. footnote 5
' 227 | self.assertEqual( 228 | response, 229 | 'Citation 4. footnote 4 Citation 5. footnote 5 Citation 6: footnote 6
', 230 | ) 231 | -------------------------------------------------------------------------------- /martor/tests/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import include, path 2 | 3 | from .views import TestFormView 4 | 5 | urlpatterns = [ 6 | path("test-form-view/", TestFormView.as_view()), 7 | path("martor/", include("martor.urls")), 8 | ] 9 | -------------------------------------------------------------------------------- /martor/tests/views.py: -------------------------------------------------------------------------------- 1 | from django.views.generic.edit import CreateView 2 | 3 | from .models import Post 4 | 5 | 6 | class TestFormView(CreateView): 7 | template_name = "test_form_view.html" 8 | model = Post 9 | fields = ["description", "wiki"] 10 | -------------------------------------------------------------------------------- /martor/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import path 2 | 3 | from .views import markdown_imgur_uploader, markdown_search_user, markdownfy_view 4 | 5 | urlpatterns = [ 6 | path("markdownify/", markdownfy_view, name="martor_markdownfy"), 7 | path("uploader/", markdown_imgur_uploader, name="imgur_uploader"), 8 | path("search-user/", markdown_search_user, name="search_user_json"), 9 | ] 10 | -------------------------------------------------------------------------------- /martor/utils.py: -------------------------------------------------------------------------------- 1 | import re 2 | 3 | import bleach 4 | from django.core.serializers.json import DjangoJSONEncoder 5 | from django.utils.functional import Promise 6 | 7 | try: 8 | from django.utils.encoding import force_str # noqa: Django>=4.x 9 | except ImportError: 10 | from django.utils.encoding import force_text as force_str # noqa: Django<=3.x 11 | 12 | import markdown 13 | 14 | from .settings import ( 15 | ALLOWED_HTML_ATTRIBUTES, 16 | ALLOWED_HTML_TAGS, 17 | ALLOWED_URL_SCHEMES, 18 | MARTOR_MARKDOWN_EXTENSION_CONFIGS, 19 | MARTOR_MARKDOWN_EXTENSIONS, 20 | ) 21 | 22 | 23 | def markdownify(markdown_text): 24 | """ 25 | Render the markdown content to HTML. 26 | 27 | Basic: 28 | >>> from martor.utils import markdownify 29 | >>> content = "" 30 | >>> markdownify(content) 31 | '
42 |
58 |
59 |
60 |
61 | {% block js %}{% endblock %}
62 |
63 |
64 |
--------------------------------------------------------------------------------
/martor_demo/app/templates/bootstrap/form.html:
--------------------------------------------------------------------------------
1 | {% extends "bootstrap/base.html" %}
2 | {% load static %}
3 | {% block title %}{{ title }} :: {{ block.super }}{% endblock %}
4 |
5 | {% block css %}
6 |
7 |
8 |
9 | {% endblock %}
10 |
11 | {% block content %}
12 |
28 | {% endblock %}
29 |
30 | {% block js %}
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
48 | {% endblock %}
49 |
--------------------------------------------------------------------------------
/martor_demo/app/templates/bootstrap/test_markdownify.html:
--------------------------------------------------------------------------------
1 | {% extends "bootstrap/base.html" %}
2 | {% load static %}
3 | {% load martortags %}
4 | {% block title %}Test Markdonify :: {{ block.super }}{% endblock %}
5 |
6 | {% block css %}
7 |
8 |
9 | {% endblock %}
10 |
11 | {% block content %}
12 |
43 | {% block messages %}
44 | {% if messages %}
45 |
52 | {% endif %}
53 | {% endblock %}
54 |
55 | {% block content %}{% endblock %}
56 |
57 |
13 |
16 |
20 | {% endblock %}
21 |
22 | {% block js %}
23 |
24 |
29 | {% endblock %}
30 |
--------------------------------------------------------------------------------
/martor_demo/app/templates/semantic/base.html:
--------------------------------------------------------------------------------
1 | {% load static %}
2 |
3 |
4 | Title: {{ post.title }}
14 |Description:
15 |16 |
17 | {{ post.description|safe_markdown }}
18 |
19 |
32 |
48 |
49 |
50 |
51 |
52 | {% block js %}{% endblock %}
53 |
54 |
55 |
--------------------------------------------------------------------------------
/martor_demo/app/templates/semantic/form.html:
--------------------------------------------------------------------------------
1 | {% extends "semantic/base.html" %}
2 | {% load static %}
3 | {% block title %}{{ title }} :: {{ block.super }}{% endblock %}
4 |
5 | {% block css %}
6 |
7 |
8 |
9 | {% endblock %}
10 |
11 | {% block content %}
12 |
30 | {% endblock %}
31 |
32 | {% block js %}
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
48 | {% endblock %}
49 |
--------------------------------------------------------------------------------
/martor_demo/app/templates/semantic/test_markdownify.html:
--------------------------------------------------------------------------------
1 | {% extends "semantic/base.html" %}
2 | {% load static %}
3 | {% load martortags %}
4 | {% block title %}Test Markdonify :: {{ block.super }}{% endblock %}
5 |
6 |
7 | {% block css %}
8 |
9 |
10 | {% endblock %}
11 |
12 | {% block content %}
13 |
33 | {% block messages %}
34 | {% if messages %}
35 |
42 | {% endif %}
43 | {% endblock %}
44 |
45 | {% block content %}{% endblock %}
46 |
47 |
14 |
17 |
21 | {% endblock %}
22 |
23 |
24 | {% block js %}
25 |
26 |
31 | {% endblock %}
32 |
--------------------------------------------------------------------------------
/martor_demo/app/urls.py:
--------------------------------------------------------------------------------
1 | from app.views import (
2 | home_redirect_view,
3 | post_form_view,
4 | simple_form_view,
5 | test_markdownify,
6 | )
7 | from django.urls import path
8 |
9 | urlpatterns = [
10 | path("", home_redirect_view, name="home_redirect"),
11 | path("simple-form/", simple_form_view, name="simple_form"),
12 | path("post-form/", post_form_view, name="post_form"),
13 | path("test-markdownify/", test_markdownify, name="test_markdownify"),
14 | ]
15 |
--------------------------------------------------------------------------------
/martor_demo/app/views.py:
--------------------------------------------------------------------------------
1 | from app.forms import PostForm, SimpleForm
2 | from app.models import Post
3 | from django.conf import settings
4 | from django.contrib import messages
5 | from django.contrib.auth.decorators import login_required
6 | from django.shortcuts import redirect, render
7 |
8 |
9 | def home_redirect_view(request):
10 | return redirect("simple_form")
11 |
12 |
13 | def simple_form_view(request):
14 | form = SimpleForm()
15 | context = {"form": form, "title": "Simple Form"}
16 | theme = getattr(settings, "MARTOR_THEME", "bootstrap")
17 | return render(request, "%s/form.html" % theme, context)
18 |
19 |
20 | @login_required
21 | def post_form_view(request):
22 | if request.method == "POST":
23 | form = PostForm(request.POST)
24 | if form.is_valid():
25 | post = form.save(commit=False)
26 | post.author = request.user
27 | post.save()
28 | messages.success(request, "%s successfully saved." % post.title)
29 | return redirect("test_markdownify")
30 | else:
31 | form = PostForm()
32 | context = {"form": form, "title": "Post Form"}
33 | theme = getattr(settings, "MARTOR_THEME", "bootstrap")
34 | return render(request, "%s/form.html" % theme, context)
35 |
36 |
37 | def test_markdownify(request):
38 | post = Post.objects.last()
39 | context = {"post": post}
40 | if post is None:
41 | context = {
42 | "post": {
43 | "title": "Fake Post",
44 | "description": """It **working**! :heart: [Python Learning](https://python.web.id)""",
45 | }
46 | }
47 | theme = getattr(settings, "MARTOR_THEME", "bootstrap")
48 | return render(request, "%s/test_markdownify.html" % theme, context)
49 |
--------------------------------------------------------------------------------
/martor_demo/manage.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | """Django's command-line utility for administrative tasks."""
3 | import os
4 | import sys
5 |
6 |
7 | def main():
8 | """Run administrative tasks."""
9 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "martor_demo.settings")
10 | try:
11 | from django.core.management import execute_from_command_line
12 | except ImportError as exc:
13 | raise ImportError(
14 | "Couldn't import Django. Are you sure it's installed and "
15 | "available on your PYTHONPATH environment variable? Did you "
16 | "forget to activate a virtual environment?"
17 | ) from exc
18 | execute_from_command_line(sys.argv)
19 |
20 |
21 | if __name__ == "__main__":
22 | main()
23 |
--------------------------------------------------------------------------------
/martor_demo/martor_demo/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/agusmakmun/django-markdown-editor/5dbc9f1f7e10931472a7309b237c66c2ecb33045/martor_demo/martor_demo/__init__.py
--------------------------------------------------------------------------------
/martor_demo/martor_demo/asgi.py:
--------------------------------------------------------------------------------
1 | """
2 | ASGI config for martor_demo project.
3 |
4 | It exposes the ASGI callable as a module-level variable named ``application``.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/4.0/howto/deployment/asgi/
8 | """
9 |
10 | import os
11 |
12 | from django.core.asgi import get_asgi_application
13 |
14 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "martor_demo.settings")
15 |
16 | application = get_asgi_application()
17 |
--------------------------------------------------------------------------------
/martor_demo/martor_demo/settings.py:
--------------------------------------------------------------------------------
1 | """
2 | Django settings for martor_demo project.
3 |
4 | Generated by 'django-admin startproject' using Django 4.0.2.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/4.0/topics/settings/
8 |
9 | For the full list of settings and their values, see
10 | https://docs.djangoproject.com/en/4.0/ref/settings/
11 | """
12 |
13 | import os
14 | import tempfile
15 | from pathlib import Path
16 |
17 | # Build paths inside the project like this: BASE_DIR / 'subdir'.
18 | BASE_DIR = Path(__file__).resolve().parent.parent
19 |
20 |
21 | # Quick-start development settings - unsuitable for production
22 | # See https://docs.djangoproject.com/en/4.0/howto/deployment/checklist/
23 |
24 | # SECURITY WARNING: keep the secret key used in production secret!
25 | SECRET_KEY = "+1zhx_fpkkyj&z+3n!63fx0)og)@h5^7qyr8e0s%c@p8_&t&+l"
26 |
27 | DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
28 |
29 | # SECURITY WARNING: don't run with debug turned on in production!
30 | DEBUG = True
31 | ALLOWED_HOSTS = ["*"]
32 |
33 | # Martor Configuration
34 | MARTOR_THEME = "bootstrap" # semantic
35 | MARTOR_ENABLE_LABEL = True
36 | MARTOR_ENABLE_CONFIGS = {
37 | "emoji": "true", # to enable/disable emoji icons.
38 | "imgur": "true", # to enable/disable imgur/custom uploader.
39 | "mention": "true", # to enable/disable mention
40 | "jquery": "true", # to include/revoke jquery (require for admin default django)
41 | "living": "false", # to enable/disable live updates in preview
42 | "spellcheck": "false", # to enable/disable spellcheck in form textareas
43 | "hljs": "true", # to enable/disable hljs highlighting in preview
44 | }
45 | MARTOR_TOOLBAR_BUTTONS = [
46 | "bold",
47 | "italic",
48 | "horizontal",
49 | "heading",
50 | "pre-code",
51 | "blockquote",
52 | "unordered-list",
53 | "ordered-list",
54 | "link",
55 | "image-link",
56 | "image-upload",
57 | "emoji",
58 | "direct-mention",
59 | "toggle-maximize",
60 | "help",
61 | ]
62 |
63 | # Application definition
64 | INSTALLED_APPS = [
65 | "django.contrib.admin",
66 | "django.contrib.auth",
67 | "django.contrib.contenttypes",
68 | "django.contrib.sessions",
69 | "django.contrib.messages",
70 | "django.contrib.staticfiles",
71 | "martor",
72 | "app",
73 | ]
74 |
75 | MIDDLEWARE = [
76 | "django.middleware.security.SecurityMiddleware",
77 | "django.contrib.sessions.middleware.SessionMiddleware",
78 | "django.middleware.common.CommonMiddleware",
79 | "django.middleware.csrf.CsrfViewMiddleware",
80 | "django.contrib.auth.middleware.AuthenticationMiddleware",
81 | "django.contrib.messages.middleware.MessageMiddleware",
82 | "django.middleware.clickjacking.XFrameOptionsMiddleware",
83 | ]
84 |
85 | ROOT_URLCONF = "martor_demo.urls"
86 |
87 | TEMPLATES = [
88 | {
89 | "BACKEND": "django.template.backends.django.DjangoTemplates",
90 | "DIRS": [],
91 | "APP_DIRS": True,
92 | "OPTIONS": {
93 | "context_processors": [
94 | "django.template.context_processors.debug",
95 | "django.template.context_processors.request",
96 | "django.contrib.auth.context_processors.auth",
97 | "django.contrib.messages.context_processors.messages",
98 | ],
99 | },
100 | },
101 | ]
102 |
103 | WSGI_APPLICATION = "martor_demo.wsgi.application"
104 |
105 |
106 | # Database
107 | # https://docs.djangoproject.com/en/4.0/ref/settings/#databases
108 |
109 | DATABASES = {
110 | "default": {
111 | "ENGINE": "django.db.backends.sqlite3",
112 | "NAME": BASE_DIR / "db.sqlite3",
113 | }
114 | }
115 |
116 |
117 | # Password validation
118 | # https://docs.djangoproject.com/en/4.0/ref/settings/#auth-password-validators
119 |
120 | AUTH_PASSWORD_VALIDATORS = [
121 | {
122 | "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
123 | },
124 | {
125 | "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
126 | },
127 | {
128 | "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
129 | },
130 | {
131 | "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
132 | },
133 | ]
134 |
135 |
136 | # Internationalization
137 | # https://docs.djangoproject.com/en/4.0/topics/i18n/
138 |
139 | LANGUAGE_CODE = "en-us"
140 |
141 | TIME_ZONE = "UTC"
142 |
143 | USE_I18N = True
144 |
145 | USE_L10N = True
146 |
147 | USE_TZ = True
148 |
149 |
150 | # Static files (CSS, JavaScript, Images)
151 | # https://docs.djangoproject.com/en/4.0/howto/static-files/
152 |
153 |
154 | STATIC_URL = "/static/"
155 | MEDIA_URL = "/media/"
156 | STATIC_ROOT = os.path.join(tempfile.gettempdir(), "martor_static")
157 | MEDIA_ROOT = os.path.join(tempfile.gettempdir(), "martor_media")
158 |
--------------------------------------------------------------------------------
/martor_demo/martor_demo/urls.py:
--------------------------------------------------------------------------------
1 | """martor_demo URL Configuration
2 |
3 | The `urlpatterns` list routes URLs to views. For more information please see:
4 | https://docs.djangoproject.com/en/4.0/topics/http/urls/
5 | Examples:
6 | Function views
7 | 1. Add an import: from my_app import views
8 | 2. Add a URL to urlpatterns: path('', views.home, name='home')
9 | Class-based views
10 | 1. Add an import: from other_app.views import Home
11 | 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home')
12 | Including another URLconf
13 | 1. Import the include() function: from django.urls import include, path
14 | 2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
15 | """
16 | from django.conf import settings
17 | from django.conf.urls.static import static
18 | from django.contrib import admin
19 | from django.urls import include, path
20 |
21 | urlpatterns = [
22 | path("admin/", admin.site.urls),
23 | path("martor/", include("martor.urls")),
24 | path("", include("app.urls")),
25 | ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
26 |
--------------------------------------------------------------------------------
/martor_demo/martor_demo/wsgi.py:
--------------------------------------------------------------------------------
1 | """
2 | WSGI config for martor_demo project.
3 |
4 | It exposes the WSGI callable as a module-level variable named ``application``.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/4.0/howto/deployment/wsgi/
8 | """
9 |
10 | import os
11 |
12 | from django.core.wsgi import get_wsgi_application
13 |
14 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "martor_demo.settings")
15 |
16 | application = get_wsgi_application()
17 |
--------------------------------------------------------------------------------
/push.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | echo '';
4 | echo " a. development";
5 | echo " b. master";
6 | echo -n "[+] branch [a/B] ➜ ";
7 | read -r branch;
8 |
9 | echo -n "[+] commit ➜ ";
10 | read -r commit;
11 |
12 | # package folder & name
13 | package=martor
14 |
15 | if [ "$commit" ] && [ "$branch" ]; then
16 | if [ "$branch" == 'b' ] || [ "$branch" == 'B' ]; then
17 | echo -n "[+] upgrade version? [y/N] ➜ ";
18 | read -r upgrade_version;
19 |
20 | if [ "$upgrade_version" == 'y' ] || [ "$upgrade_version" == 'Y' ]; then
21 | # https://stackoverflow.com/a/3250387/6396981
22 | old_version=$(grep '__VERSION__ = ".*"' $package/__init__.py | cut -d '"' -f 2);
23 | old_release_date=$(grep '__RELEASE_DATE__ = ".*"' $package/__init__.py | cut -d '"' -f 2);
24 | echo "[i] current version is $old_version, released at $old_release_date";
25 |
26 | last_numb_old_version=$(echo "$old_version" | grep -o .$);
27 | last_numb_new_version=$(( last_numb_old_version + 1 ))
28 |
29 | suggested_version="${old_version%?}${last_numb_new_version}"
30 | echo -n "[+] type new version [default:$suggested_version] ➜ ";
31 | read -r input_new_version;
32 |
33 | if [ ! "$input_new_version" ]; then
34 | input_new_version=$suggested_version;
35 | fi
36 |
37 | # 04-Sep-2022
38 | new_release_date=$(date +%d-%b-%Y);
39 |
40 | # https://stackoverflow.com/a/525612/6396981
41 | # sed -i -e => for linux user
42 | # sed -i "" => for mac user
43 | echo "[i] updating new version..."
44 | find $package/ -type f \( -name "*.py" -or -name "*.css" -or -name "*.js" \) -exec sed -i "" "s/$old_version/$input_new_version/g" {} \;
45 | find $package/ -type f \( -name "*.py" -or -name "*.css" -or -name "*.js" \) -exec sed -i "" "s/$old_release_date/$new_release_date/g" {} \;
46 | fi
47 |
48 | git add .;
49 | git commit -m "$commit";
50 | git checkout master;
51 | git push origin master;
52 |
53 | if [ "$upgrade_version" == 'y' ] || [ "$upgrade_version" == 'Y' ]; then
54 | echo "[i] updating new git tag to v$input_new_version"
55 | git tag -a v"$input_new_version" -m "launch v$input_new_version"
56 | git push origin v"$input_new_version"
57 |
58 | echo "[i] preparing upload to pypi..."
59 | if ! [ -x "$(command -v twine)" ]; then
60 | pip install twine
61 | fi
62 |
63 | python setup.py sdist
64 | twine upload dist/"$package-$input_new_version".tar.gz
65 | fi
66 | else
67 | git add .;
68 | git commit -m "$commit";
69 | git checkout development;
70 | git push origin development;
71 | fi
72 |
73 | echo "[i] successfully pushed at $(date)";
74 | else
75 | echo "[!] not pushed!";
76 | fi
77 |
--------------------------------------------------------------------------------
/requirements-dev.txt:
--------------------------------------------------------------------------------
1 | -r requirements.txt
2 |
3 | isort
4 | black
5 | flake8
6 | twine
7 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | urllib3<2 ; python_version < '3.7' # urllib3 2.0 dropped support for Python 3.6
2 | zipp<3.7 ; python_version < '3.7' # zipp 3.7.0 dropped support for Python 3.6
3 | Django>=3.2
4 | Markdown<3.6
5 | requests
6 | bleach
7 | tzdata
8 |
--------------------------------------------------------------------------------
/runtests.py:
--------------------------------------------------------------------------------
1 | import os
2 | import sys
3 |
4 | import django
5 | from django.conf import settings
6 |
7 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
8 |
9 | settings.configure(
10 | SECRET_KEY="xxxxx",
11 | DEBUG=True,
12 | DATABASES={
13 | "default": {
14 | "NAME": ":memory:",
15 | "ENGINE": "django.db.backends.sqlite3",
16 | }
17 | },
18 | MIDDLEWARE=[
19 | "django.middleware.security.SecurityMiddleware",
20 | "django.contrib.sessions.middleware.SessionMiddleware",
21 | "django.middleware.common.CommonMiddleware",
22 | "django.middleware.csrf.CsrfViewMiddleware",
23 | "django.contrib.auth.middleware.AuthenticationMiddleware",
24 | "django.contrib.messages.middleware.MessageMiddleware",
25 | "django.middleware.clickjacking.XFrameOptionsMiddleware",
26 | ],
27 | TEMPLATES=[
28 | {
29 | "BACKEND": "django.template.backends.django.DjangoTemplates",
30 | "DIRS": [
31 | os.path.join(BASE_DIR, "django-markdown-editor/martor/templates"),
32 | os.path.join(BASE_DIR, "django-markdown-editor/martor/tests/templates"),
33 | ],
34 | "APP_DIRS": True,
35 | "OPTIONS": {
36 | "context_processors": [
37 | "django.template.context_processors.debug",
38 | "django.template.context_processors.request",
39 | "django.contrib.auth.context_processors.auth",
40 | "django.contrib.messages.context_processors.messages",
41 | ],
42 | },
43 | }
44 | ],
45 | STATIC_URL="/static/",
46 | ROOT_URLCONF="martor.tests.urls",
47 | INSTALLED_APPS=[
48 | "django.contrib.auth",
49 | "django.contrib.contenttypes",
50 | "django.contrib.sessions",
51 | "django.contrib.messages",
52 | "django.contrib.admin",
53 | "martor",
54 | ],
55 | )
56 |
57 | django.setup()
58 | from django.test.runner import DiscoverRunner
59 |
60 | test_runner = DiscoverRunner(verbosity=1)
61 |
62 |
63 | failures = test_runner.run_tests(["martor"])
64 | if failures:
65 | sys.exit(failures)
66 |
--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [metadata]
2 | description_file = README.md
3 |
4 | [flake8]
5 | ignore = E402,E501,W503,W504,E731,E741
6 | exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules,.vscode
7 |
8 | [pycodestyle]
9 | max-line-length = 120
10 | exclude = .tox,.git,*/migrations/*,*/static/CACHE/*,docs,node_modules
11 |
12 | [mypy]
13 | python_version = 3.7
14 | check_untyped_defs = True
15 | ignore_missing_imports = True
16 | warn_unused_ignores = True
17 | warn_redundant_casts = True
18 | warn_unused_configs = True
19 | plugins = mypy_django_plugin.main
20 |
21 | [mypy-*.migrations.*]
22 | # Django migrations should not produce any errors:
23 | ignore_errors = True
24 |
25 | [codespell]
26 | skip = *.po,,*/static,*.png,*.jpg,*.jpeg,*.svg,*.ico,*.zip,*.pdf,*.egg-info,*/build
27 | ignore-words-list=delink,mimicing,beforeall,afterall,ninjs,womens
28 | count =
29 | quiet-level = 3
30 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | from setuptools import find_packages, setup
2 |
3 | from martor import __AUTHOR__, __AUTHOR_EMAIL__, __VERSION__
4 |
5 |
6 | def get_requirements():
7 | return open("requirements.txt").read().splitlines()
8 |
9 |
10 | setup(
11 | name="martor",
12 | version=__VERSION__,
13 | packages=find_packages(exclude=["*demo"]),
14 | include_package_data=True,
15 | zip_safe=False,
16 | description="Django Markdown Editor",
17 | url="https://github.com/agusmakmun/django-markdown-editor",
18 | download_url="https://github.com/agusmakmun/django-markdown-editor/tarball/v%s"
19 | % __VERSION__,
20 | keywords=["martor", "django markdown", "django markdown editor"],
21 | long_description=open("README.md").read(),
22 | long_description_content_type="text/markdown",
23 | license="GNUGPL-v3",
24 | author=__AUTHOR__,
25 | author_email=__AUTHOR_EMAIL__,
26 | classifiers=[
27 | "Development Status :: 5 - Production/Stable",
28 | "Environment :: Web Environment",
29 | "Framework :: Django",
30 | "Framework :: Django :: 3.2",
31 | "Framework :: Django :: 4.0",
32 | "Framework :: Django :: 4.1",
33 | "Framework :: Django :: 4.2",
34 | "Intended Audience :: Developers",
35 | "Operating System :: OS Independent",
36 | "Programming Language :: JavaScript",
37 | "Programming Language :: Python",
38 | "Programming Language :: Python :: 3.8",
39 | "Programming Language :: Python :: 3.9",
40 | "Programming Language :: Python :: 3.10",
41 | "Topic :: Software Development :: Libraries :: Python Modules",
42 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
43 | ],
44 | install_requires=get_requirements(),
45 | project_urls={
46 | "Documentation": "https://github.com/agusmakmun/django-markdown-editor?tab=readme-ov-file#installation",
47 | "Release notes": "https://github.com/agusmakmun/django-markdown-editor/releases",
48 | "Funding": "https://www.paypal.com/paypalme/summonagus",
49 | "Source": "https://github.com/agusmakmun/django-markdown-editor",
50 | "Issue Tracker": "https://github.com/agusmakmun/django-markdown-editor/issues",
51 | },
52 | )
53 |
--------------------------------------------------------------------------------
Title: {{ post.title }}
15 |Description:
16 |17 |
18 | {{ post.description|safe_markdown }}
19 |
20 |