[docusaurus] Add feature for math equations

Author: VladNastase

openedu_builder/plugins/docusaurus.py

@@ -85,6 +85,7 @@ def _parse_config_options(self):
             or isinstance(x[list(x.keys())[0]], dict)
         ]
         config_template_args["copyright_string"] = self.config.get("copyright_string")
+        config_template_args["math"] = self.config.get("math", False)
 
         return config_template_args
 
@@ -464,6 +465,22 @@ def run(self):
             except FileNotFoundError:
                 log.info("index.js already removed")
 
+        if self.config.get("math", False):
+            math_command = [
+                "npm",
+                "install",
+                "--save",
+                "remark-math@3",
+                "rehype-katex@5",
+                "hast-util-is-element@1.1.0",
+            ]
+            p = subprocess.run(math_command, capture_output=True)
+            if p.returncode != 0:
+                log.error(f"Command {math_command} failed with code {p.returncode}")
+                log.error(f"STDOUT: {p.stdout.decode('utf-8')}")
+                log.error(f"STDERR: {p.stderr.decode('utf-8')}")
+                raise PluginRunError(f"Error while installing math dependencies command")
+
         p = subprocess.run(self.build_command, capture_output=True)
         if p.returncode != 0:
             log.error(f"Command {self.build_command} failed with code {p.returncode}")

openedu_builder/plugins/docusaurus_templates/config.jinja2

@@ -3,6 +3,10 @@
 
 const lightCodeTheme = require('prism-react-renderer/themes/github');
 const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+{% if math -%}
+const math = require('remark-math');
+const katex = require('rehype-katex');
+{%- endif %}
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -19,6 +23,10 @@ const config = {
           routeBasePath: '/',
           {% endif -%}
           sidebarPath: require.resolve('./sidebars.js'),
+          {%- if math %}
+          remarkPlugins: [math],
+          rehypePlugins: [katex],
+          {%- endif %}
         },
         blog: false,
         theme: {
@@ -28,6 +36,18 @@ const config = {
     ],
   ],
 
+  {%- if math %}
+  stylesheets: [
+    {
+      href: 'https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css',
+      type: 'text/css',
+      integrity:
+        'sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM',
+      crossorigin: 'anonymous',
+    },
+  ],
+  {% endif -%}
+
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({