Comprehensive Markdown plugin built for Django

Last update: Dec 21, 2022

Overview

Django MarkdownX

Django MarkdownX is a comprehensive Markdown plugin built for Django, the renowned high-level Python web framework, with flexibility, extensibility, and ease-of-use at its core.

Documentation

https://neutronx.github.io/django-markdownx/

Key features

Raw editing.
Live preview.
Drag & drop image uploads (automatically stored in the designated location in the Media directory).
Customizable image insertion tag.
Definition of maximum size for an image.
Definition of acceptable image formats (PNG, JPEG, SVG).
Image manipulations (compression, size reduction, cropping, upscaling).
Pre- and post- text modification.
Easy template customization, layout modification, and personalization.
Multiple editors per page.
Django Admin support.

Preview

(using Bootstrap for layout and styling – not included in package)

Comments

Disable TAB key if CTRL was down

This stops the editor receiving a TAB event if using CTRL-TAB to cycle browser tabs. Otherwise the tab works as it should.

Related to #66.

~~One problem though, not entirely sure how to deal with it. While the tab does get ignored when doing CTRL+TAB, for some reason the cursor jumps to the end of the text area. I'm not sure what to do about that.~~
enhancement

opened by jaywink 16
[SOLVED] Render markdown to HTML in template
Hi there

I'm new here, and I'm having an issue rendering markdownx to HTML. I use this tag :

{{ post.content|safe }}

But it's not working. And I cannot find in the docs (Maybe I missed it?)

Thank you!
duplicate
opened by alzearafat 11
Make it possible to customize image insertion code.

It can be useful to insert more that just a markdown image tag, for example to provide additional control on the layout of images. Since there's no convenient way to handle this on the JavaScript side, we generate the code to insert in Python. Then it can be overridden with the existing extensibility mechanism, that is, with a custom view.

opened by aaugustin 11
Handle csrf stored in sessions

This allow to use CSRF_USE_SESSIONS = True which store crsf token in session instead of cookies. It checks if csrf token found in cookies otherwise try to get csrf token in session.

opened by Intestinall 10

self.attrs problem

I have a problem to develop using this package.

class MyModelForm(forms.ModelForm):
  class Meta:
    model = MyModel
    field_classes = {'content': MarkdownxFormField,}
    widgets = {'content': MarkdowxWidget(attrs={'class':'form-control'})}

So I override your function 'render' and merge attrs and self.attrs and it works. Also, I think it will handle this problem.

class MarkdownxWidgetImproved(MarkdownxWidget):
  def render(self, name, value, attrs=None):
    allAttrs = {**attrs, **self.attrs}
    return super(MarkdownxWidgetImproved, self).render(name, value, allAttrs)

I request pull, but canceled because I expect that that code doesn't work when attrs is None.

opened by sh0416 10

Preview not working on outside admin (on frontend)
Hi.

I have successfully configured markdown field and it works fine in the admin:

I also use it in my custom form on frontend, but unfortunately, the preview does not work. I can see the requests in the "Network" tab in the Google Chrome Developer Tools and I see the response is correctly returned:

I debugged markdown.js file at line 477:

xhr.success = function (response) { console.log('success'); console.log(response); properties.preview.innerHTML = response; properties.editor = updateHeight(properties.editor); utils_1.triggerCustomEvent('markdownx.update', properties.parent, [response]); };

and the result is, that "response" variable is always null:

Any idea what can cause the issue?

pip:

Django==2.0.2 django-markdownx==2.0.22
opened by eriktelepovsky 9
Security issue - Vulnerable to XSS attack
Description

A security problem exists when markdownx.js dynamically interprets the content of the form without first checking the content. The application is vulnerable to XSS attack.

Versions

django 1.11.13 and 2.2.5,

python 2.7.16 and 3.7.4.

django-markdownx 2.0.28.

Preview
opened by LzOggar 8
Line breaks in code blocks
Hello,

I would expect line breaks to be parsed in code blocks.

For example, the markdown

```javascript var x = 1; var y = 2; ``` should render, much like it does on Github, as

var x = 1; var y = 2;

Instead, markdownx renders it as

var x = 1; var y = 2;

Is that intentional or am I missing something?

Thank you for building markdownx! -- Niko
question
opened by nstahl 8
Size settings for non-svg images and inclusion of xml+svg in Settings
Rectified the error causing image size alteration for non-svg images being ignored.

Additionally, broke down pieces of code into task-specific functions inline with functional/OOP programming best practices, but also to make them easier to read and debug.

image/xml+svg is now included in the default settings.

Also tested on Python 3.6 - works perfectly fine.

Reminder: This would require a minor version change + pipy update as the error I found was preventing the application from performing one of the preceding features.
opened by xenatisch 8
Template
Hello, can you help me ? :smile: I don`t know how to show my markdown data on template. I have something like

<h1>{{ post.title }}</h1> <p>{{ post.text }}</p> <p>{{ post.markdown }}</p>

and i see only

title text #text1 ![](/media/markdownx/ab3bfac7-7509-411a-96c8-11aebc20b873.jpg)

but i want compiled version (with image) Could you explain how templates with markdownx work ? Or create some exaple with that ? :smile:
opened by StudentDawid 8
View opacity reset after invalid image upload

When working on https://github.com/neutronX/django-markdownx/issues/143 i noticed the view opacity is not reset after uploading an invalid image. Proposal: remove return null on this line, so the properties.editor.style.opacity = NORMAL_OPACITY; is called correctly. https://github.com/neutronX/django-markdownx/blob/master/markdownx/static/markdownx/js/markdownx.js#L457

What is the reason to return null here?

opened by JeroenvO 7
Bump actions/checkout from 2.3.2 to 3.2.0
Bumps actions/checkout from 2.3.2 to 3.2.0.

Release notes

Sourced from actions/checkout's releases.

v3.2.0

What's Changed

Add GitHub Action to perform release by @rentziass in actions/checkout#942

Fix status badge by @ScottBrenner in actions/checkout#967

Replace datadog/squid with ubuntu/squid Docker image by @cory-miller in actions/checkout#1002

Wrap pipeline commands for submoduleForeach in quotes by @jokreliable in actions/checkout#964

Update @actions/io to 1.1.2 by @cory-miller in actions/checkout#1029

Upgrading version to 3.2.0 by @vmjoseph in actions/checkout#1039

New Contributors

@ScottBrenner made their first contribution in actions/checkout#967

@cory-miller made their first contribution in actions/checkout#1002

@jokreliable made their first contribution in actions/checkout#964

@vmjoseph made their first contribution in actions/checkout#1039

Full Changelog: https://github.com/actions/checkout/compare/v3...v3.2.0

v3.1.0

What's Changed

Inject GitHub host to be able to clone from another GitHub instance by @peter-murray in actions/checkout#922

Bump @actions/core to 1.10.0 by @rentziass in actions/checkout#939

New Contributors

@peter-murray made their first contribution in actions/checkout#922

@rentziass made their first contribution in actions/checkout#939

Full Changelog: https://github.com/actions/checkout/compare/v3.0.2...v3.1.0

v3.0.2

What's Changed

Add set-safe-directory input to allow customers to take control. by @TingluoHuang in actions/checkout#770

Prepare changelog for v3.0.2. by @TingluoHuang in actions/checkout#777

Full Changelog: https://github.com/actions/checkout/compare/v3...v3.0.2

v3.0.1

Fixed an issue where checkout failed to run in container jobs due to the new git setting safe.directory

Bumped various npm package versions

v3.0.0

Updated to the node16 runtime by default

This requires a minimum Actions Runner version of v2.285.0 to run, which is by default available in GHES 3.4 or later.

v2.5.0

What's Changed

Update @actions/core to 1.10.0 by @rentziass in actions/checkout#962

Full Changelog: https://github.com/actions/checkout/compare/v2...v2.5.0

... (truncated)

Changelog

Sourced from actions/checkout's changelog.

Changelog

v3.1.0

Use @actions/core saveState and getState

Add github-server-url input

v3.0.2

Add input set-safe-directory

v3.0.1

Fixed an issue where checkout failed to run in container jobs due to the new git setting safe.directory

Bumped various npm package versions

v3.0.0

Update to node 16

v2.3.1

Fix default branch resolution for .wiki and when using SSH

v2.3.0

Fallback to the default branch

v2.2.0

Fetch all history for all tags and branches when fetch-depth=0

v2.1.1

Changes to support GHES (here and here)

v2.1.0

Group output

Changes to support GHES alpha release

Persist core.sshCommand for submodules

Add support ssh

Convert submodule SSH URL to HTTPS, when not using SSH

Add submodule support

Follow proxy settings

Fix ref for pr closed event when a pr is merged

Fix issue checking detached when git less than 2.22

v2.0.0

Do not pass cred on command line

Add input persist-credentials

Fallback to REST API to download repo

... (truncated)

Commits

755da8c 3.2.0 (#1039)

26d48e8 Update @actions/io to 1.1.2 (#1029)

bf08527 wrap pipeline commands for submoduleForeach in quotes (#964)

5c3ccc2 Replace datadog/squid with ubuntu/squid Docker image (#1002)

1f9a0c2 README - fix status badge (#967)

8230315 Add workflow to update a main version (#942)

93ea575 Prepare release v3.1.0 (#940)

6a84743 Bump @actions/core to 1.10.0 (#939)

e6d535c Inject GitHub host to be able to clone from another GitHub instance (#922)

2541b12 Prepare changelog for v3.0.2. (#777)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies github_actions
opened by dependabot[bot] 0

Simple optimization inside views.py

Instead of importing the markdownify function every time the view's POST method is called, instead import it at global scope.

Example:

markdownify_func = import_string(MARKDOWNX_MARKDOWNIFY_FUNCTION)

class MarkdownifyView(View):
    """
    Conversion of Markdown to HTML.
    """

    def post(self, request, *args, **kwargs):
        """
        Handling of the conversion from Markdown to HTML using the conversion
        function in settings under ``MARKDOWNX_MARKDOWNIFY_FUNCTION``.

        :param request: HTTP request.
        :param args: Default Django POST arguments.
        :param kwargs: Default Django POST keyword arguments.
        :return: HTTP response
        :rtype: django.http.HttpResponse
        """
        # Function used to be imported every POST request. 
        return HttpResponse(markdownify_func(request.POST['content']))

opened by Nigel2392 0

Bump actions/setup-python from 2 to 4
Bumps actions/setup-python from 2 to 4.

Release notes

Sourced from actions/setup-python's releases.

v4.0.0

What's Changed

Support for python-version-file input: #336

Example of usage:

- uses: actions/setup-python@v4 with: python-version-file: '.python-version' # Read python version from a file - run: python my_script.py

There is no default python version for this setup-python major version, the action requires to specify either python-version input or python-version-file input. If the python-version input is not specified the action will try to read required version from file from python-version-file input.

Use pypyX.Y for PyPy python-version input: #349

Example of usage:

- uses: actions/setup-python@v4 with: python-version: 'pypy3.9' # pypy-X.Y kept for backward compatibility - run: python my_script.py

RUNNER_TOOL_CACHE environment variable is equal AGENT_TOOLSDIRECTORY: #338

Bugfix: create missing pypyX.Y symlinks: #347

PKG_CONFIG_PATH environment variable: #400

Added python-path output: #405 python-path output contains Python executable path.

Updated zeit/ncc to vercel/ncc package: #393

Bugfix: fixed output for prerelease version of poetry: #409

Made pythonLocation environment variable consistent for Python and PyPy: #418

Bugfix for 3.x-dev syntax: #417

Other improvements: #318 #396 #384 #387 #388

Update actions/cache version to 2.0.2

In scope of this release we updated actions/cache package as the new version contains fixes related to GHES 3.5 (actions/setup-python#382)

Add "cache-hit" output and fix "python-version" output for PyPy

This release introduces new output cache-hit (actions/setup-python#373) and fix python-version output for PyPy (actions/setup-python#365)

The cache-hit output contains boolean value indicating that an exact match was found for the key. It shows that the action uses already existing cache or not. The output is available only if cache is enabled.

... (truncated)

Commits

d09bd5e fix: 3.x-dev can install a 3.y version (#417)

f72db17 Made env.var pythonLocation consistent for Python and PyPy (#418)

53e1529 add support for python-version-file (#336)

3f82819 Fix output for prerelease version of poetry (#409)

397252c Update zeit/ncc to vercel/ncc (#393)

de977ad Merge pull request #412 from vsafonkin/v-vsafonkin/fix-poetry-cache-test

22c6af9 Change PyPy version to rebuild cache

081a3cf Merge pull request #405 from mayeut/interpreter-path

ff70656 feature: add a python-path output

fff15a2 Use pypyX.Y for PyPy python-version input (#349)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies github_actions
opened by dependabot[bot] 0

getCookie() bug?

        var cookies = document.cookie
            .split(';')
            .filter(function (cookie) { return cookie.indexOf(name + "=") === 0; })[0];

code works when cookie is csrftoken=xyz; abc=def but fails on abc=def; csrftoken=xyz

opened by alphatownsman 0

Release for Django 4.0

The last release on PyPI can't work with Django 4.0 because of the API shift in Django.

The current code does work, and we're putting it in production.

It's mildly inconvenient to have to pin our requirements to a Git commit ID, though. Would it be possible to get a PyPI-uploaded version for Django 4.0?

opened by joelburton 0

Releases(v4.0.0-beta.1)

v4.0.0-beta.1(Jan 3, 2022)
Added:

Support for Django 4 (retains backward compatibility with Django 2 and 3)

Support for Python 3.9 and 3.10

Changed:

Minor correction in German translation

Removed:

Built documentation assets, which are now built via the CI.

Source code(tar.gz)
Source code(zip)
v3.0.1(Dec 28, 2019)
Fixed:

django's internal db field type

Source code(tar.gz)
Source code(zip)
v3.0.0(Dec 26, 2019)
Added:

support for Django 2 and 3

support for python 3.6, 3.7 and 3.8

Removed:

support of Django < 2

python 2.7 code

Fixed:

minor compatibility issues

Source code(tar.gz)
Source code(zip)
v2.0.28(Nov 21, 2018)
Fixed:

AttributeError on invalid image upload

Source code(tar.gz)
Source code(zip)
v2.0.27(Nov 15, 2018)

Fixed: missing compiled static files
Source code(tar.gz)
Source code(zip)
v2.0.26(Nov 13, 2018)
Fixed:

Missing custom attributes for markdownx widget

Handle csrf stored in sessions

Source code(tar.gz)
Source code(zip)
v2.0.25(Nov 13, 2018)

Fixes for Django 2.1
Source code(tar.gz)
Source code(zip)
v2.0.24(Sep 11, 2018)

Django 2.1 support
Source code(tar.gz)
Source code(zip)
v2.0.23(Apr 18, 2018)

Django 2.0 support
Source code(tar.gz)
Source code(zip)
v2.0.21(May 4, 2017)
Fixes:

Removed testapp package from the release

Source code(tar.gz)
Source code(zip)
v2.0.20(May 4, 2017)
New:

JS now ensures that the element is visible before attempting to resize it (files read as binary are not converted to str).

Documentations compiled via ./create_docs.sh now get .nojekyll files added in the root directory by default.

Added migrations for testapp

Fixed:

Fixed JS monitoring in SVG file - again.

Issue in dev.py preventing the installation of documentations dependencies is fixed.

package.json is generated when using Vagrant or Docker environment

Improved:

Contribution documentations are now even more comprehensive.

dev.py now deletes SQLite file created for the test.

Support of minified css

Static source files are now excluded from releases

Source code(tar.gz)
Source code(zip)
v1.8(May 4, 2017)

JavaScript event listener were added to account for the progress during upload, enabling the usage of animation (e.g. spinner) or inform the user of failed attempts.
Source code(tar.gz)
Source code(zip)
v1.6(May 4, 2017)
Support for Django's default_storage

Fix for missing MARKDOWNX_MARKDOWNIFY_FUNCTION in settings

Source code(tar.gz)
Source code(zip)
v2.0.19(May 4, 2017)
url(r'^upload/$', ImageUploadView.as_view(), name='markdownx_upload'),

url(r'^markdownify/$', MarkdownifyView.as_view(), name='markdownx_markdownify'),

Source code(tar.gz)
Source code(zip)
v2.0.18(May 2, 2017)

MARKDOWNX_IMAGE_MAX_SIZE not respected #65 issue fixed.
Source code(tar.gz)
Source code(zip)
v2.0.14(Apr 25, 2017)
Fixed:

Fixed the bug that caused non-SVG files being screened for JavaScript.

Other:

Minor clean ups.

Added documentations for developers' environment.

Updated module documentations.

Made dev.py -no-container and dev.py -c compatible with Python 2.

Source code(tar.gz)
Source code(zip)
v2.0(Apr 23, 2017)
New:

Django 1.11 support

Documentations

Developers' environment

Support for ctrl/cmd + ] and ctrl/cmd + [ for indentations (line and block).

Support for Tab and Shift + Tab (line, selection, and block).

Improved:

Pure JavaScript front-end without external dependencies.

Additional settings for added flexibility.

Source code(tar.gz)
Source code(zip)
v1.7.1(Jan 16, 2017)

Fix for custom CSS classes in the widget
Source code(tar.gz)
Source code(zip)
v1.7(Jan 16, 2017)
SVG file upload support

Multiwidget support

Source code(tar.gz)
Source code(zip)
v1.6.3(Jan 16, 2017)
Corrupted image upload exception

Source code(tar.gz)
Source code(zip)
v1.6.2(Jan 16, 2017)
Runtest template fix

Source code(tar.gz)
Source code(zip)
v1.5(Jan 16, 2017)
Possibility to customize image insertion code

Source code(tar.gz)
Source code(zip)
v1.4.3(Jan 16, 2017)
Markdown abstractable function fix

Source code(tar.gz)
Source code(zip)
v1.4.2(Jan 16, 2017)
Maintenance release

Source code(tar.gz)
Source code(zip)
v1.4.1(Jan 16, 2017)
Make rendering the markdown abstractable

Source code(tar.gz)
Source code(zip)
v1.4(Jan 16, 2017)
Added JS (jQuery) events

Custom upload url path

Fix when subclassing MarkdownxWidget

Source code(tar.gz)
Source code(zip)
v1.3(Jan 16, 2017)
Added Markdown extension configuration setting

Source code(tar.gz)
Source code(zip)
v1.2.1(Jan 16, 2017)
Fix by Eduard Sukharev: Fix accessing file length in python3

Source code(tar.gz)
Source code(zip)
v1.2(Jan 16, 2017)
Added custom url path setting MARKDOWNX_URLS_PATH to compile markdown with custom view (i.e. for pre/post altering markdown text)

Source code(tar.gz)
Source code(zip)
v1.1.3(Jan 16, 2017)
Setup tools fix

Source code(tar.gz)
Source code(zip)