mkdocs-katex-ssr 1.0.5__py3-none-any.whl → 1.0.6__py3-none-any.whl

mkdocs_katex_ssr/plugin.py

@@ -7,6 +7,7 @@ import threading
 import warnings
 import logging
 import shutil
+import time
 from mkdocs.plugins import BasePlugin
 from mkdocs.config import config_options
 from mkdocs.utils import get_relative_url
@@ -30,8 +31,11 @@ for logger_name in ["mkdocs", "mkdocs.plugins", "py.warnings", ""]:
 
 logging.captureWarnings(True)
 
+log = logging.getLogger('mkdocs.plugins.katex-ssr')
+
 class KatexSsrPlugin(BasePlugin):
     config_scheme = (
+        ('verbose', config_options.Type(bool, default=False)),
         ('katex_dist', config_options.Type(str, default='https://cdn.jsdelivr.net/npm/katex@latest/dist/')),
         ('katex_css_filename', config_options.Type(str, default='katex.min.css')),
         ('add_katex_css', config_options.Type(bool, default=True)),
@@ -159,12 +163,12 @@ class KatexSsrPlugin(BasePlugin):
                 cursor = self.db_conn.execute("SELECT html FROM katex_cache WHERE hash=?", (cache_key,))
                 row = cursor.fetchone()
                 if row:
-                    return row[0]
+                    return row[0], True
             except Exception as e:
                 print(f"Error reading cache: {e}")
 
         if not self.process:
-            return None
+            return None, False
         
         with self.lock:
             payload = {
@@ -180,7 +184,7 @@ class KatexSsrPlugin(BasePlugin):
                 
                 response_line = self.process.stdout.readline()
                 if not response_line:
-                    return None
+                    return None, False
                 
                 result = json.loads(response_line.decode('utf-8'))
                 if result.get('status') == 'success':
@@ -195,7 +199,7 @@ class KatexSsrPlugin(BasePlugin):
                                 )
                         except Exception as e:
                             print(f"Error saving to cache: {e}")
-                    return html
+                    return html, False
                 else:
                     print(f"KaTeX error: {result.get('message')}")
             except Exception as e:
@@ -203,12 +207,16 @@ class KatexSsrPlugin(BasePlugin):
                     stderr_content = self.process.stderr.read()
                     if stderr_content:
                         print(f"Renderer died with: {stderr_content.decode('utf-8', errors='replace')}")
-            return None
+            return None, False
 
     def on_post_page(self, output, page, config):
         if not self.process:
             return output
 
+        start_time = time.time()
+        formula_count = 0
+        cache_count = 0
+
         soup = BeautifulSoup(output, 'html.parser')
         math_elements = soup.find_all(class_='arithmatex')
         for el in math_elements:
@@ -228,11 +236,20 @@ class KatexSsrPlugin(BasePlugin):
             else:
                 latex = content
             
-            rendered_html = self._render_latex(latex, display_mode)
-            new_soup = BeautifulSoup(rendered_html, 'html.parser')
+            rendered_html, from_cache = self._render_latex(latex, display_mode)
+            
+            if rendered_html:
+                formula_count += 1
+                if from_cache:
+                    cache_count += 1
+                
+                new_soup = BeautifulSoup(rendered_html, 'html.parser')
+                el.clear()
+                el.append(new_soup)
 
-            el.clear()
-            el.append(new_soup)
+        if self.config['verbose']:
+            duration = (time.time() - start_time) * 1000
+            log.info(f"Katex-SSR processed {page.file.src_path} in {duration:.2f}ms: {formula_count} formulas ({cache_count} cached)")
 
         # Assets Injection
         css_file = self.config['katex_css_filename']

{mkdocs_katex_ssr-1.0.5.dist-info → mkdocs_katex_ssr-1.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-katex-ssr
-Version: 1.0.5
+Version: 1.0.6
 Summary: A MkDocs plugin for server-side rendering of KaTeX math.
 Author-email: RainPPR <2125773894@qq.com>
 License-Expression: MIT
@@ -38,6 +38,7 @@ Traditional client-side rendering relies on JavaScript in the browser to convert
 - **High Performance**: Uses a persistent Node.js process to render equations efficiently without spawning a new process for every item.
 - **Offline Support**: Optional "Offline Mode" copies all necessary CSS, fonts, and scripts to your site directory, removing external CDN dependencies.
 - **Smart Asset Management**: Separate configuration for server-side processing scripts (like `mhchem`) and client-side interactive scripts (like `copy-tex`).
+- **Performance Monitoring**: Detailed build-time logging for each page tracking formula counts, cache hits, and processing speeds.
 - **Clean Output**: Aggressive warning suppression for a quieter build log.
 
 ## Installation
@@ -65,6 +66,7 @@ markdown_extensions:
 plugins:
   - katex-ssr:
       # --- Basic Configuration ---
+      verbose: true # Enable build logs for each page
       katex_dist: "https://cdn.jsdelivr.net/npm/katex@latest/dist/"
       add_katex_css: true
       katex_css_filename: "katex-swap.min.css" # Use swap version for better font-display behavior
@@ -107,6 +109,7 @@ plugins:
 
 | Option | Type | Default | Description |
 | :--- | :--- | :--- | :--- |
+| `verbose` | bool | `false` | If true, logs the number of formulas, cache hits, and time spent processing each page. |
 | `katex_dist` | str | jsDelivr | Base URL for CDN, or local file path to KaTeX distribution. |
 | `add_katex_css` | bool | `true` | Whether to inject the CSS link tag. |
 | `katex_css_filename` | str | `katex.min.css` | The specific CSS file to load. `katex-swap.min.css` is recommended. |

mkdocs_katex_ssr-1.0.6.dist-info/RECORD

@@ -0,0 +1,8 @@
+mkdocs_katex_ssr/plugin.py,sha256=lSSSH-LPyik6ZA4eblYb81PFNzzWxIcZ5GsIyrS9wek,13823
+mkdocs_katex_ssr/renderer.js,sha256=15lIck7GXZHiAza9IpnSbu9HmeklaDp_zubetQQowkU,1967
+mkdocs_katex_ssr-1.0.6.dist-info/licenses/LICENSE,sha256=Bea4m1bAyMhuJT5bCGl76QfpKatJarfMzl9vcrdXRgQ,1064
+mkdocs_katex_ssr-1.0.6.dist-info/METADATA,sha256=0pkDe-rFgP1OQCM2ACdBbqMhFMGLDJFdMdWBW9_Ys10,5704
+mkdocs_katex_ssr-1.0.6.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+mkdocs_katex_ssr-1.0.6.dist-info/entry_points.txt,sha256=l3PrOPi_1AqGLse2BTZVz2SB8rn3I4NRVI-wDUbIHVg,68
+mkdocs_katex_ssr-1.0.6.dist-info/top_level.txt,sha256=FdfQyPUx4r9kgiqTW4da0TPUdBbOda_0PXjVkfGmsgs,17
+mkdocs_katex_ssr-1.0.6.dist-info/RECORD,,

mkdocs_katex_ssr-1.0.5.dist-info/RECORD

@@ -1,8 +0,0 @@
-mkdocs_katex_ssr/plugin.py,sha256=-T7CYjyCuELmKcphpOSSMxUJ_WTBk1KvLCLgor_94-I,13163
-mkdocs_katex_ssr/renderer.js,sha256=15lIck7GXZHiAza9IpnSbu9HmeklaDp_zubetQQowkU,1967
-mkdocs_katex_ssr-1.0.5.dist-info/licenses/LICENSE,sha256=Bea4m1bAyMhuJT5bCGl76QfpKatJarfMzl9vcrdXRgQ,1064
-mkdocs_katex_ssr-1.0.5.dist-info/METADATA,sha256=nOHPUpLTurAhn678qSG69kWYr_lDgn0IfslItkBVt4U,5398
-mkdocs_katex_ssr-1.0.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-mkdocs_katex_ssr-1.0.5.dist-info/entry_points.txt,sha256=l3PrOPi_1AqGLse2BTZVz2SB8rn3I4NRVI-wDUbIHVg,68
-mkdocs_katex_ssr-1.0.5.dist-info/top_level.txt,sha256=FdfQyPUx4r9kgiqTW4da0TPUdBbOda_0PXjVkfGmsgs,17
-mkdocs_katex_ssr-1.0.5.dist-info/RECORD,,