Merge pull request #172 from empowerplan/feature/markdown

Add markdown rendering
empowerplan · Nov 7, 2024 · c64b890 · c64b890
2 parents 43c767f + 65aedc9
commit c64b890
Show file tree

Hide file tree

Showing 9 changed files with 121 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@ and this project tries to adhere to [Semantic Versioning](https://semver.org/spe
 
 ## [Unreleased]
 ### Added
+- markdown rendering
 - link to changelog in docs panel
 - progress bar to show simulation state
 - WMS layers flurstuecke and ertragspotenzial

diff --git a/config/settings/base.py b/config/settings/base.py
@@ -91,6 +91,7 @@
     "rest_framework",
     "django_distill",
     "template_partials",
+    "markdownify.apps.MarkdownifyConfig",
 ]
 
 LOCAL_APPS = ["digiplan.map.apps.MapConfig", "django_oemof", "django_mapengine"]
@@ -266,6 +267,15 @@ def __getitem__(self, item):  # noqa: D105, ANN001, ANN204
 CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"
 CRISPY_TEMPLATE_PACK = "bootstrap5"
 
+MARKDOWNIFY = {
+    "default": {
+        "BLEACH": False,
+        "MARKDOWN_EXTENSIONS": [
+            "markdown.extensions.extra",
+        ],
+    },
+}
+
 OEMOF_SCENARIO = env.str("OEMOF_SCENARIO", "scenario_2045")
 
 # django-mapengine

diff --git a/digiplan/map/config.py b/digiplan/map/config.py
@@ -28,6 +28,9 @@
 ADDITIONAL_TRAFFIC_SETTINGS_FILE = settings.DATA_DIR.path("digipipe/settings/traffic_settings_panel.json")
 TECHNOLOGY_DATA_FILE = settings.DIGIPIPE_DIR.path("scalars").path("technology_data.json")
 
+# MARKDOWNS
+LANDING_PAGE_MD = utils.read_file(settings.APPS_DIR.path("static/markdown/landing_page.md"))
+
 # FILTERS
 FILTER_DEFINITION = {}
 REGION_FILTER_LAYERS = []

diff --git a/digiplan/map/utils.py b/digiplan/map/utils.py
@@ -8,6 +8,12 @@
 from django.template.context import make_context
 
 
+def read_file(filename: str) -> str:
+    """Read file."""
+    with pathlib.Path(filename).open("r", encoding="utf-8") as f:
+        return f.read()
+
+
 def get_translated_json_from_file(json_filename: str, request: HttpRequest = None) -> dict:
     """
     Render JSON using translations.

diff --git a/digiplan/map/views.py b/digiplan/map/views.py
@@ -32,6 +32,7 @@ class MapGLView(TemplateView, views.MapEngineMixin):
         "pv_map_control": _("Negativkriterien PV"),
         "store_hot_init": config.STORE_HOT_INIT,
         "oemof_scenario": settings.OEMOF_SCENARIO,
+        "markdown": {"landing_page": config.LANDING_PAGE_MD},
     }
 
     def get_context_data(self, **kwargs) -> dict:

diff --git a/digiplan/static/markdown/landing_page.md b/digiplan/static/markdown/landing_page.md
@@ -0,0 +1,15 @@
+# Test
+
+This is a test list:
+
+* a
+* b
+* c
+* d
+    * holla
+
+| Month    | Savings |
+| -------- | ------- |
+| January  | $250    |
+| February | $80     |
+| March    | $420    |
diff --git a/digiplan/templates/components/map.html b/digiplan/templates/components/map.html
@@ -1,4 +1,4 @@
-{% load static i18n %}
+{% load static i18n markdownify %}
 
 {%  include "components/onboarding.html" %}
 
@@ -23,23 +23,7 @@ <h1 class="modal-title fs-5 fw-bold ps-1" id="goalModalLabel">Ziele</h1>
             <div id="onboarding_wind_chart" class="onboarding__chart" style="width: 448px; height: 320px;"></div>
           </div>
           <div class="challenges-modal__text">
-            Hier folgt noch Text zu diesen Punkten:
-            <ul>
-              <li>Vom Großen ins Kleine</li>
-              <li>Klimaziele und EE-Ziele Deutschland</li>
-              <li>Energiestrategie Brandenburg und Regionales Energiekonzept OLS</li>
-              <li>Stand Ausbau Wind & PV</li>
-              <li>Tool beleuchtet ausgewählte Aspekte, Beispiele</li>
-              <li>Beispielhafte Fragen aus Präsi:
-                <ul>
-                  <li>Wie viel Energie kann auf den geplanten Windvorranggebieten "geerntet" werden?</li>
-                  <li>Und wie viel mit Aufdach- und Agri-Photovoltaik?</li>
-                  <li>Genügt das, um den zukünftigen Energiebedarf der Region zu decken, auch den der Wärmepumpen und Elektroautos?</li>
-                  <li>Bis zu welchem Grad kann Oderland-Spree energetisch unabhängig werden?</li>
-                  <li>Wie passt das zur Brandenburger Energiestrategie 2040?</li>
-                </ul>
-              </li>
-            </ul>
+            {{ markdown.landing_page | markdownify }}
           </div>
         </div>
         <div class="challenges-modal">

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,6 +41,7 @@ geojson = "^3.0.1"
 oemof-network = "0.5.0a5"
 django-template-partials = "^23.4"
 django-cache-memoize = "^0.2.0"
+django-markdownify = "^0.9.5"
 
 [tool.poetry.group.dev.dependencies]
 Werkzeug = "^2.0.1" # https://github.com/pallets/werkzeug