2018-11-16 22:02:06 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< link rel = "shortcut icon" href = "../img/favicon.ico" >
< title > Getting Started - Django Markdownx< / title >
< link href = 'https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel = 'stylesheet' type = 'text/css' >
< link rel = "stylesheet" href = "../css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "../css/theme_extra.css" type = "text/css" / >
< link rel = "stylesheet" href = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" >
< script >
// Current page data
var mkdocs_page_name = "Getting Started";
var mkdocs_page_input_path = "getting_started.md";
var mkdocs_page_url = "/django-markdownx/getting_started/";
< / script >
< script src = "../js/jquery-2.1.1.min.js" defer > < / script >
< script src = "../js/modernizr-2.8.3.min.js" defer > < / script >
< script src = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js" > < / script >
< script src = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/bash.min.js" > < / script >
< script src = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/django.min.js" > < / script >
< script > hljs . initHighlightingOnLoad ( ) ; < / script >
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side stickynav" >
< div class = "wy-side-nav-search" >
< a href = ".." class = "icon icon-home" > Django Markdownx< / a >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" title = "Type search term here" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul class = "current" >
< li class = "toctree-l1" >
< a class = "" href = ".." > Django MarkdownX< / a >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../installation/" > Installation< / a >
< / li >
< li class = "toctree-l1 current" >
< a class = "current" href = "./" > Getting Started< / a >
< ul class = "subnav" >
< li class = "toctree-l2" > < a href = "#getting-started" > Getting Started< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../example/" > Example< / a >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../customization/" > Customization< / a >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../javascript/" > JavaScript< / a >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../translations/" > Translations< / a >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../contributions/" > Contributions< / a >
< / li >
< li class = "toctree-l1" >
< a class = "" href = "../license/" > License< / a >
< / li >
< / ul >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = ".." > Django Markdownx< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = ".." > Docs< / a > » < / li >
< li > Getting Started< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "https://github.com/neutronX/django-markdownx/edit/master/docs/getting_started.md"
class="icon icon-github"> Edit on GitHub< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" >
< div class = "section" >
< h1 id = "getting-started" > Getting Started< a class = "headerlink" href = "#getting-started" title = "Permanent link" > ¶ < / a > < / h1 >
< p > First and foremost, add < code > markdownx< / code > to the list of < code > INSTALLED_APPS< / code > in < code > settings.py< / code > .< / p >
2019-12-26 19:22:57 +00:00
< pre class = "highlight" > < code class = "language-python" > INSTALLED_APPS = (
# [...]
'markdownx',
)< / code > < / pre >
2018-11-16 22:02:06 +00:00
< p > You may alter default behaviours by adding and changing relevant variables in your settings. See < a href = "../customization/" > customization< / a > for additional information.< / p >
< p > Add MarkdownX URL patterns to your < code > urls.py< / code > . You can do this using either of these methods depending on your style:< / p >
2019-12-26 19:22:57 +00:00
< pre class = "highlight" > < code class = "language-python" > urlpatterns = [
# [...]
url(r'^markdownx/', include('markdownx.urls')),
]< / code > < / pre >
2018-11-16 22:02:06 +00:00
< p > or alternatively:< / p >
2019-12-26 19:22:57 +00:00
< pre class = "highlight" > < code class = "language-python" > from django.conf.urls import url, include
from markdownx import urls as markdownx
2018-11-16 22:02:06 +00:00
2019-12-26 19:22:57 +00:00
urlpatterns += [
url(r'^markdownx/', include(markdownx))
]< / code > < / pre >
2018-11-16 22:02:06 +00:00
2020-04-21 01:10:51 +00:00
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > Make sure that you have defined < code > MEDIA_ROOT< / code > and < code > MEDIA_URL< / code > in your < code > settings.py< / code > to enable MarkdownX's image upload feature.
< / p >
< / div >
2018-11-16 22:02:06 +00:00
< div class = "admonition caution" >
< p class = "admonition-title" > Caution< / p >
< p > Don't forget to collect MarkdownX assets to your < code > STATIC_ROOT< / code > . To do this, run:< / p >
2019-12-26 19:22:57 +00:00
< pre class = "highlight" > < code class = "language-python" > python3 manage.py collectstatic< / code > < / pre >
2018-11-16 22:02:06 +00:00
< p > Replace < code > python3< / code > with the your interpreter of choice.< / p >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "../example/" class = "btn btn-neutral float-right" title = "Example" > Next < span class = "icon icon-circle-arrow-right" > < / span > < / a >
< a href = "../installation/" class = "btn btn-neutral" title = "Installation" > < span class = "icon icon-circle-arrow-left" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
<!-- Copyright etc -->
< / div >
Built with < a href = "http://www.mkdocs.org" > MkDocs< / a > using a < a href = "https://github.com/snide/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< div class = "rst-versions" role = "note" style = "cursor: pointer" >
< span class = "rst-current-version" data-toggle = "rst-current-version" >
< a href = "https://github.com/neutronX/django-markdownx/" class = "fa fa-github" style = "float: left; color: #fcfcfc" > GitHub< / a >
< span > < a href = "../installation/" style = "color: #fcfcfc;" > « Previous< / a > < / span >
< span style = "margin-left: 15px" > < a href = "../example/" style = "color: #fcfcfc" > Next » < / a > < / span >
< / span >
< / div >
< script > var base _url = '..' ; < / script >
< script src = "../js/theme.js" defer > < / script >
< script src = "../search/main.js" defer > < / script >
< / body >
< / html >
