Add TeX rendering to CodeHelp response view. Fixes #6.

liffiton · Nov 10, 2024 · 243e923 · 243e923
1 parent b4abb45
commit 243e923
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/src/codehelp/prompts.py b/src/codehelp/prompts.py
@@ -57,6 +57,7 @@
 
 - Do not write a corrected or updated version of the student's code.  You must not write code for the student.
 - Use Markdown formatting, including ` for inline code.
+- Use TeX syntax for mathematical formulas, wrapping them in \\(...\\) or \\[...\\] as appropriate.
 - Do not write a heading for the response.
 - Do not write any example code blocks.
 - If the student wrote in a language other than English, always respond in the student's own language.

diff --git a/src/codehelp/templates/help_view.html b/src/codehelp/templates/help_view.html
@@ -7,10 +7,17 @@
 {% extends "base.html" %}
 {% from "recent_queries.html" import recent_queries %}
 
+{% block extrahead %}
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+" crossorigin="anonymous">
+<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" integrity="sha384-7zkQWkzuo3B5mTepMUcHkMB5jZaolc2xDwL6VFqjFALcbeS9Ggm/Yr2r3Dy4lfFg" crossorigin="anonymous"></script>
+<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous"
+    onload="renderMathInElement(document.querySelector('#codehelp_response'));"></script>
+{% endblock %}
+
 {% block body %}
 <div class="columns is-desktop is-gapless">
   <div class="column is-three-quarters-desktop">
-    <section class="section">
+    <section class="section" id="codehelp_response">
     {% if query %}
 
     <div class="container">

diff --git a/src/gened/filters.py b/src/gened/filters.py
@@ -63,7 +63,8 @@ def fmt_response_txt(value: str) -> str:
             return markupsafe.Markup(html_string)
 
     # Jinja filter for converting Markdown to HTML
-    markdown_processor = MarkdownIt("js-default")  # https://markdown-it-py.readthedocs.io/en/latest/security.html
+    markdown_processor = MarkdownIt("js-default")  # js-default: https://markdown-it-py.readthedocs.io/en/latest/security.html
+    markdown_processor.inline.ruler.disable(['escape'])  # disable escaping so that \(, \[, etc. come through for TeX math
 
     @app.template_filter('markdown')
     def markdown_filter(value: str) -> str: