Convert markdown to html in changelog list (inside update modal windows)

Stefal · Jan 28, 2025 · bf8ca73 · bf8ca73
1 parent eaa90c1
commit bf8ca73
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 - Detect Gnss receiver firmware version during receiver detection. [#428](https://github.com/Stefal/rtkbase/issues/428)
 - GUI -> Logs: Non-zipped files can be convert to rinex. [#348](https://github.com/Stefal/rtkbase/issues/348)
 - GUI -> Settings: Display network informations.
+- GUI -> Settings: Better changelog display (Convert markdown to html).
 ### Changed
 - Faster Septentrio Mosaic-X5 detection
 ### Fixed

diff --git a/web_app/static/lib/snarkdown.js b/web_app/static/lib/snarkdown.js
diff --git a/web_app/static/lib/snarkdown.js.map b/web_app/static/lib/snarkdown.js.map
diff --git a/web_app/static/settings.js b/web_app/static/settings.js
@@ -426,11 +426,14 @@ $(document).ready(function () {
         }else if (response.new_release) {
             $("#updateModal .modal-title").text("Update available!");
             $("#updateModal .modal-body").append('<p class="text-center">Do you want to install RTKBase <b>' + response['new_release'] +'</b>? <br>It will take a few minutes.</p>');                    
-            var newFeaturesArray = response['comment'].split('\r\n');
-            $("#updateModal .modal-body").append('<p><ul id="newFeatures">Content:</ul></p>');
-            $.each( newFeaturesArray, function( index, value ){
-                $("#newFeatures").append("<li>" + value.replace(/^\+ /g, "") + "</li>");
-            });       
+            $("#updateModal .modal-body").append('<p id="newFeatures"></p>');
+            var markdwnHtml = snarkdown(response['comment']);
+            //lower <Hx> title tags values
+                markdwnHtml= markdwnHtml.replace(/<h([1-4])(.*?)>(.*?)<\/h\1>/gi, (match, p1, p2, p3) => {
+                    const newHtag = Math.min(parseInt(p1) + 3, 6);
+                    return `<h${newHtag}${p2}>${p3}</h${newHtag}>`;
+                });
+            $("#newFeatures").append('<p>' + markdwnHtml + '</p>');     
             $("#start-update-button").removeAttr("disabled");
             $("#updateModal").modal();
         } else {

diff --git a/web_app/templates/settings.html b/web_app/templates/settings.html
@@ -790,5 +790,6 @@ <h4 class="modal-title">Shutdown</h4>
 {% block scripts %}
 {{super()}}
 <script type="text/javascript" src="{{ url_for('static', filename='lib/bootstrap4-toggle.js') }}" charset="utf-8"></script>
+<script type="text/javascript" src="{{ url_for('static', filename='lib/snarkdown.js') }}" charset="utf-8"></script>
 <script type="text/javascript" src="{{ url_for('static', filename='settings.js', v=g.version) }}" charset="utf-8"></script>
 {% endblock %}