Hopiu/django-markdownx
1
0
Fork 0
mirror of https://github.com/Hopiu/django-markdownx.git synced 2026-03-16 21:40:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs update

Browse source
This commit is contained in:
adi 2020-02-25 20:36:54 +01:00
parent 359f31350f
commit 30f2930fb3
5 changed files with 12 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/customization/index.html
View file

@ -148,17 +148,10 @@
<h2 id="general-ex-settings">General (ex. settings)<a class="headerlink" href="#general-ex-settings" title="Permanent link">&para;</a></h2>
<h3 id="widget">Widget<a class="headerlink" href="#widget" title="Permanent link">&para;</a></h3>
<p>The default widget is as seen <a href="https://github.com/neutronX/django-markdownx/blob/master/markdownx/templates/markdownx/widget.html">here</a>.</p>
<p>If you would like to customise this; for instance, using <a href="https://getbootstrap.com">Bootstrap v3</a> to implement side-by-side panes (as seen in :doc:<code>preview animation&lt;index&gt;</code>), you should override the default widget’s template by creating your own template and saving it under <code>markdownx/widget2.html</code> (Django 1.11+), or <code>markdownx/widget.html</code> (Django 1.10 and below) in your project's <code>TEMPLATE_DIRS</code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In the case of Django 1.11+, you will need to <a href="https://docs.djangoproject.com/en/1.11/ref/forms/renderers/#overriding-built-in-widget-templates">change the renderer</a> (Django docs) to <code>TemplatesSetting</code>.</p>
</div>
<p>If you would like to customise this; for instance, using <a href="https://getbootstrap.com">Bootstrap v3</a> to implement side-by-side panes (as seen in :doc:<code>preview animation&lt;index&gt;</code>), you should override the default widget’s template by creating your own template and saving it under <code>markdownx/widget.html</code> in your project's <code>TEMPLATE_DIRS</code>.</p>
<p>Here is an example of the contents:</p>
<pre class="highlight"><code class="language-html">&lt;div class="markdownx row"&gt;
&lt;div class="col-md-6"&gt;
&lt;!-- Django 1.10 and below --&gt;
{{ markdownx_editor }}
&lt;!-- Django 1.11+ --&gt;
{% include 'django/forms/widgets/textarea.html' %}
&lt;/div&gt;
&lt;div class="col-md-6"&gt;

2
docs/index.html
View file

@ -227,5 +227,5 @@ found on our <a href="https://github.com/adi-/django-markdownx/graphs/contributo
<!--
MkDocs version : 1.0.4
Build Date UTC : 2019-12-26 17:25:21
Build Date UTC : 2020-02-25 19:34:36
-->

2
docs/search/search_index.json
View file

File diff suppressed because one or more lines are too long

18
docs/sitemap.xml
View file

@ -2,47 +2,47 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://neutronx.github.io/django-markdownx/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://neutronx.github.io/django-markdownx/installation/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://neutronx.github.io/django-markdownx/getting_started/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://neutronx.github.io/django-markdownx/example/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://neutronx.github.io/django-markdownx/customization/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://neutronx.github.io/django-markdownx/javascript/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://neutronx.github.io/django-markdownx/translations/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://neutronx.github.io/django-markdownx/contributions/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://neutronx.github.io/django-markdownx/license/</loc>
<lastmod>2019-12-26</lastmod>
<lastmod>2020-02-25</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
docs/sitemap.xml.gz
View file

Binary file not shown.