[SOLVED] Render markdown to HTML in template

[alzearafat]

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!

[adi-]

Most of the info how to properly setup markdownx is written in the docs. Please read it carefully.

To be able to give you some tips, more info with your issue is needed.

[alzearafat]

Thankyou @adi-

I already read the setup, and it's already working in admin/model. Now I want to display it in template, but not working. It not rendered as HTML, just plain text.

I usually just using this {{ post.content|safe }} tag in another WYSIWG editor and just workin fine :/

[alzearafat]

I just solved the issue, using template tag filter and 'markdownx.utils.markdownify' function. This is the steps (I dont know if this is the best way or not, but it works as I expected) :

1. I create custom template tag filter :

from django import template
from markdownx.utils import markdownify

register = template.Library()

@register.filter
def show_markdown(text):
    return markdownify(text)

2. And then just call it in template :

{{ post.content|show_markdown|safe }}

3. Now it rendered as HTML

[xenatisch]

There are plenty of options to achieve this; most of which take the same approach as you've manually implemented yourself.

We exemplify this in the documentations for the purpose of preview alongside the editor, but not for final stand-alone displays.

Thanks for sharing anyway!

[denizdogan]

Shouldn't there be a built-in way to render Markdown to HTML in Django templates?

Since the Markdown is previewed live in the admin, I assumed that there was a way to render Markdown in any Django template using a filter. I feel like that should definitely be in the scope of this project. The documentation could definitely be improved to clarify that we have to implement this on our own.

[tonykyriakidis]

I completely agree with @denizdogan , this should be in the scope of the project and the documentation could be improved. There should be a section on how to render markdown in templates with a proper/complete example.

[adi-]

Same as #77

[spatocode]

I solved the problem in this way. It's probably the easiest way.

model.py
from markdownx.models import MarkdownxField
from markdownx.utils import markdownify

class Article(models.Model):
author = models.ForeignKey('auth.User', on_delete=models.CASCADE)
title = models.CharField(max_length=100, unique=True)
content = MarkdownxField()

def formatted_markdown(self):
     return markdownify(self.content)

template.html

{{ article.formatted_markdown|safe }}

[JulioCoder]

I solved the problem in this way. It's probably the easiest way.

model.py
from markdownx.models import MarkdownxField
from markdownx.utils import markdownify

class Article(models.Model):
author = models.ForeignKey('auth.User', on_delete=models.CASCADE)
title = models.CharField(max_length=100, unique=True)
content = MarkdownxField()

def formatted_markdown(self):
     return markdownify(self.content)

template.html

{{ article.formatted_markdown|safe }}

I worked for me, now is rendering ok, but the quotes are not working.

[jonathan-daniel]

For anyone coming here for a XSS safe solution: #163

[bitFez]

I tried the above solutions without much luck. After much fiddling, I managed to pull it off and decided to write this up since I can see other users above also had the same issues as myself.

@alzearafat
tutorial here: https://blog.devgenius.io/django-markdown-part-1-rendering-it-b61cbcbc833e#6d86-8337ea5bff80