mirror of
https://github.com/Hopiu/django-markdownx.git
synced 2026-03-17 05:50:23 +00:00
231 lines
8.4 KiB
HTML
231 lines
8.4 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">
|
|
<meta name="description" content="None">
|
|
|
|
<link rel="shortcut icon" href="img/favicon.ico">
|
|
<title>Django MarkdownX - 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 = "Django MarkdownX";
|
|
var mkdocs_page_input_path = "index.md";
|
|
var mkdocs_page_url = "/django-markdownx/";
|
|
</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 current">
|
|
|
|
<a class="current" href=".">Django MarkdownX</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l2"><a href="#django-markdownx">Django MarkdownX</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l3" href="#key-features">Key features</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#preview">Preview</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#acknowledgements">Acknowledgements</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
</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">
|
|
|
|
<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>Django MarkdownX</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/neutronX/django-markdownx/edit/master/docs/index.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="django-markdownx">Django MarkdownX<a class="headerlink" href="#django-markdownx" title="Permanent link">¶</a></h1>
|
|
<p><img alt="" src="https://img.shields.io/pypi/v/django-markdownx.svg" />
|
|
<img alt="" src="https://img.shields.io/pypi/status/django-markdownx.svg" />
|
|
<img alt="" src="https://img.shields.io/travis/neutronX/django-markdownx.svg" />
|
|
<img alt="" src="https://img.shields.io/pypi/pyversions/django-markdownx.svg" />
|
|
<img alt="" src="https://img.shields.io/badge/Django-2.0,%202.1,%202.2,%203.0-green.svg" />
|
|
<img alt="" src="https://img.shields.io/pypi/l/django-markdownx.svg" /></p>
|
|
<p>Django MarkdownX is a comprehensive <a href="https://en.wikipedia.org/wiki/Markdown">Markdown</a> plugin built for <a href="https://www.djangoproject.com">Django</a>, the renowned high-level Python web framework, with flexibility, extensibility, and ease-of-use at its core.</p>
|
|
<p><strong>GitHub:</strong> <a href="https://github.com/neutronX/django-markdownx">https://github.com/neutronX/django-markdownx</a><br>
|
|
<strong>PyPi:</strong> <a href="https://pypi.org/project/django-markdownx/">https://pypi.org/project/django-markdownx/</a></p>
|
|
<h2 id="key-features">Key features<a class="headerlink" href="#key-features" title="Permanent link">¶</a></h2>
|
|
<ul>
|
|
<li>Raw editing.</li>
|
|
<li>Live preview.</li>
|
|
<li>Drag & drop image uploads (automatically stored in the designated location in the <em>Media</em> directory).</li>
|
|
<li>Customizable image insertion tag.</li>
|
|
<li>Definition of maximum size for an image.</li>
|
|
<li>Definition of acceptable image formats (PNG, JPEG, SVG).</li>
|
|
<li>Image manipulations (compression, size reduction, cropping, upscaling).</li>
|
|
<li>Pre- and post- text modification.</li>
|
|
<li>Easy template customization, layout modification, and personalization.</li>
|
|
<li>Multiple editors per page.</li>
|
|
<li>Django Admin support.</li>
|
|
</ul>
|
|
<h2 id="preview">Preview<a class="headerlink" href="#preview" title="Permanent link">¶</a></h2>
|
|
<p><img alt="django-markdownx preview" src="https://github.com/neutronX/django-markdownx/raw/master/django-markdownx-preview.gif?raw=true" /></p>
|
|
<h2 id="acknowledgements">Acknowledgements<a class="headerlink" href="#acknowledgements" title="Permanent link">¶</a></h2>
|
|
<p>We acknowledge and appreciate every contribution made towards improving <strong>Django MarkdownX</strong>, a list of which can be
|
|
found on our <a href="https://github.com/adi-/django-markdownx/graphs/contributors">GitHub contributors page</a>.</p>
|
|
<p><strong>Django MarkdownX</strong> was inspired by the great <a href="https://github.com/mirumee/django-images">Django Images</a> and
|
|
<a href="https://github.com/aj-may/django-bootstrap-markdown">Django Bootstrap Markdown</a> packages.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="installation/" class="btn btn-neutral float-right" title="Installation">Next <span class="icon icon-circle-arrow-right"></span></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 style="margin-left: 15px"><a href="installation/" 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>
|
|
|
|
<!--
|
|
MkDocs version : 1.0.4
|
|
Build Date UTC : 2020-02-25 19:34:36
|
|
-->
|