mirror of
https://github.com/Hopiu/django-markdownx.git
synced 2026-03-17 05:50:23 +00:00
246 lines
8.3 KiB
HTML
246 lines
8.3 KiB
HTML
<!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>Example - 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 = "Example";
|
|
var mkdocs_page_input_path = "example.md";
|
|
var mkdocs_page_url = "/django-markdownx/example/";
|
|
</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">
|
|
|
|
<a class="" href="../getting_started/">Getting Started</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
|
|
<a class="current" href="./">Example</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l2"><a href="#example">Example</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l3" href="#model">Model</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#form">Form</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#django-admin">Django Admin</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
</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>Example</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/neutronX/django-markdownx/edit/master/docs/example.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h1>
|
|
<p>Have you:</p>
|
|
<ul>
|
|
<li>successfully <a href="../installation/">installed MarkdownX</a>?</li>
|
|
<li>followed the instructions on how to <a href="../getting_started/">get started</a>?</li>
|
|
</ul>
|
|
<p>If so, you are set for the next step. Here you can find comprehensive examples of how to use different MarkdownX
|
|
features to your advantage.</p>
|
|
<h2 id="model">Model<a class="headerlink" href="#model" title="Permanent link">¶</a></h2>
|
|
<p>This is how you implement a MarkdownX field in your models. In your <code>app/models.py</code>:</p>
|
|
<pre class="highlight"><code class="language-python">from markdownx.models import MarkdownxField
|
|
|
|
class MyModel(models.Model):
|
|
myfield = MarkdownxField()</code></pre>
|
|
|
|
<p>... and then, include the form media in the relevant template using <code>{{ form.media }}</code>, like so:</p>
|
|
<pre class="highlight"><code class="language-html"><form method="POST" action="">{% csrf_token %}
|
|
{{ form }}
|
|
</form>
|
|
|
|
{{ form.media }}</code></pre>
|
|
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>The field extends Django's own <a href="https://docs.djangoproject.com/en/dev/ref/models/fields/#django.db.models.TextField">TextField</a> and is saved in the database accordingly.</p>
|
|
</div>
|
|
<h2 id="form">Form<a class="headerlink" href="#form" title="Permanent link">¶</a></h2>
|
|
<p>You can also implement MarkdownX through the forms. This will be done in your <code>app/forms.py</code> as follows:</p>
|
|
<pre class="highlight"><code class="language-python">from markdownx.fields import MarkdownxFormField
|
|
|
|
class MyForm(forms.Form):
|
|
myfield = MarkdownxFormField()</code></pre>
|
|
|
|
<p>... and then, include a form's required media in the template using <code>{{ form.media }}</code>:</p>
|
|
<pre class="highlight"><code class="language-html"><form method="POST" action="">{% csrf_token %}
|
|
{{ form }}
|
|
</form>
|
|
|
|
{{ form.media }}</code></pre>
|
|
|
|
<h2 id="django-admin">Django Admin<a class="headerlink" href="#django-admin" title="Permanent link">¶</a></h2>
|
|
<p>When using included <code>MarkdowxModel</code> class in your models, just use <code>MarkdownxModelAdmin</code> in your <code>app/admin.py</code> as follows:</p>
|
|
<pre class="highlight"><code class="language-python">from django.contrib import admin
|
|
from markdownx.admin import MarkdownxModelAdmin
|
|
from .models import MyModel
|
|
|
|
admin.site.register(MyModel, MarkdownxModelAdmin)</code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../customization/" class="btn btn-neutral float-right" title="Customization">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../getting_started/" class="btn btn-neutral" title="Getting Started"><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="../getting_started/" style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="../customization/" 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>
|