Getting StartedΒΆ

  1. First and foremost, add markdownx to the list of INSTALLED_APPS in settings.py.
INSTALLED_APPS = (
    # [...]
    'markdownx',
)

You may alter default behaviours by adding and changing relevant variables in your settings. See customization for additional information.

  1. Add MarkdownX URL patterns to your urls.py.

You can do this using either of these methods depending on your style:

urlpatterns = [
    [...]
    url(r'^markdownx/', include('markdownx.urls')),
]

or alternatively:

1
2
3
4
5
6
from django.conf.urls import url, include
from markdownx import urls as markdownx

urlpatterns += [
    url(r'^markdownx/', include(markdownx))
]

Important

Don’t forget to collect MarkdownX assets to your STATIC_ROOT. To do this, run:

python3 manage.py collectstatic

Replace python3 with the your interpreter of choice.