Markdown (#214)

* Add basic markdown support site wide

* Improved MD support.

Add some styling for images in MD

Add support for the bastardisation of the MD html for RML.

* Add processing for <ul> in RML

* Add OL processing to RML

* Fix a bug with squares appearing around the last page number

* Remove rml formatting in event_detail

* Improve handling of code blocks in RML

* Add MD to rigboard

Reduce MD title sizes as they were offensively large

* Add parsing of markdown when editing event items

* Improved list handling in RML

* Add tests for markdown support.

Focuses mainly on RML as that's where it will break

* Add indications of where MD support is enabled as per comment by @samozzy in #178.

Isn't quite a full description, but for the most part this should be enough for the people who know how to use it see where they can use it.

* Add failing test for markdown processing none

* Fix for failing test in e0d56e

* Add failing test for using single line breaks as per comment on #214

* Enable line break extension for single breaks in paragraphs by new lines.

Pass tests in ef3de607c3

* Enable GH flavour linebreaks in JS rendered markdown

* Made RML bullets pretty :)

* Added WYSIWYG editor. Works for notes & description, fails miserably for items :(

* Fixed for event items. Will probably fail tests because selenium can't type in simpleMDE :(

* FIX: Re-enable markdown on paperwork

Strikethrough is broken in all sorts of places for whatever reason

* FEAT: Markdown support on asset comments

* FIX: Prevent js injection through markdown fields

* Initial fixes

* Basic dark theme for simplemde

* Swap to locally delivered SimpleMDE

* Region for selenium testing of SimpleMDE

Bleh, Javascript all around

* Tests passing!

Fixed not using region for item modal, and overflow error on paperwork with really long description. Looks junk but I'm not really bothered

* Pep8 fixes

* Fallback for null HCapatcha sitekey

I.e. when we're on a branch

* Fix item description print being broken

* Actually fix sitekey problem

* Fixes for using markdown in asset comments

* Properly initialise markdown on asset comments

Co-authored-by: David Taylor <david@taylorhq.com>
Co-authored-by: FreneticScribbler <aj@aronajones.com>

assets/templates/asset_form.html

@@ -5,11 +5,14 @@
 {% block css %}
     {{ block.super }}
     <link rel="stylesheet" href="{% static 'css/selects.css' %}"/>
+    <link rel="stylesheet" type="text/css" href="{% static 'css/simplemde.min.css' %}">
 {% endblock %}
 
 {% block preload_js %}
     {{ block.super }}
     <script src="{% static 'js/selects.js' %}"></script>
+    <script src="{% static 'js/simplemde.min.js' %}"></script>
+    <script src="{% static 'js/interaction.js' %}"></script>
 {% endblock %}
 
 {% block js %}
@@ -72,6 +75,11 @@
             preserveSelected: false
         });
     </script>
+    <script>
+        $(document).ready(function () {
+            setupMDE('#id_comments');
+        });
+    </script>
 {% endblock %}
 
 {% block content %}

assets/templates/partials/asset_detail_form.html

@@ -1,4 +1,6 @@
 {% load widget_tweaks %}
+{% load markdown_tags %}
+
 <div class="card">
   <div class="card-header">
     Asset Details
@@ -38,14 +40,14 @@
     <!---TODO: Lower default number of lines in comments box-->
     <div class="form-group">
       <label for="{{ form.comments.id_for_label }}">Comments</label>
-      {% render_field form.comments|add_class:'form-control' %}
+      {% render_field form.comments|add_class:'form-control md-enabled' %}
     </div>
     {% else %}
     <dt>Asset ID</dt>
     <dd>{{ object.asset_id }}</dd>
 
     <dt>Description</dt>
-    <dd style="overflow-wrap: break-word;">{{ object.description }}</dd>
+    <dd>{{ object.description }}</dd>
 
     <dt>Category</dt>
     <dd>{{ object.category }}</dd>
@@ -57,7 +59,7 @@
     <dd>{{ object.serial_number|default:'-' }}</dd>
 
     <dt>Comments</dt>
-    <dd style="overflow-wrap: break-word;">{{ object.comments|default:'-'|linebreaksbr }}</dd>
+    <dd style="overflow-wrap: break-word;">{{ object.comments|default:'-'|markdown }}</dd>
     {% endif %}
   </div>
 </div>

assets/tests/pages.py

@@ -77,7 +77,7 @@ class AssetForm(FormPage):
         'description': (regions.TextBox, (By.ID, 'id_description')),
         'is_cable': (regions.CheckBox, (By.ID, 'id_is_cable')),
         'serial_number': (regions.TextBox, (By.ID, 'id_serial_number')),
-        'comments': (regions.TextBox, (By.ID, 'id_comments')),
+        'comments': (regions.SimpleMDETextArea, (By.ID, 'id_comments')),
         'purchase_price': (regions.TextBox, (By.ID, 'id_purchase_price')),
         'salvage_value': (regions.TextBox, (By.ID, 'id_salvage_value')),
         'date_acquired': (regions.DatePicker, (By.ID, 'id_date_acquired')),