mkdocs-katex-ssr 1.0.4__tar.gz → 1.0.6__tar.gz

{mkdocs_katex_ssr-1.0.4 → mkdocs_katex_ssr-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-katex-ssr
-Version: 1.0.4
+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.4 → mkdocs_katex_ssr-1.0.6}/README.md

@@ -22,6 +22,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
@@ -49,6 +50,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
@@ -91,6 +93,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.4 → mkdocs_katex_ssr-1.0.6}/mkdocs_katex_ssr/plugin.py

@@ -1,11 +1,13 @@
 import os
 import json
+import sqlite3
+import hashlib
 import subprocess
 import threading
 import warnings
 import logging
-import requests
 import shutil
+import time
 from mkdocs.plugins import BasePlugin
 from mkdocs.config import config_options
 from mkdocs.utils import get_relative_url
@@ -29,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)),
@@ -48,6 +53,8 @@ class KatexSsrPlugin(BasePlugin):
         self.lock = threading.Lock()
         self._asset_cache = {}
         self._local_dist_path = None
+        self.db_conn = None
+        self.db_path = None
 
     def _ensure_trailing_slash(self, path):
         if not path.endswith('/') and not path.endswith('\\'):
@@ -66,6 +73,21 @@ class KatexSsrPlugin(BasePlugin):
         
         project_dir = os.path.dirname(config['config_file_path'])
         
+        # Initialize Cache DB
+        try:
+            cache_dir = os.path.join(project_dir, '.cache', 'plugin', 'katex-ssr')
+            os.makedirs(cache_dir, exist_ok=True)
+            self.db_path = os.path.join(cache_dir, 'cache.db')
+            self.db_conn = sqlite3.connect(
+                self.db_path, 
+                check_same_thread=False
+            )
+            with self.db_conn:
+                self.db_conn.execute('CREATE TABLE IF NOT EXISTS katex_cache (hash TEXT PRIMARY KEY, html TEXT)')
+        except Exception as e:
+            print(f"Warning: Failed to initialize KaTeX SSR cache: {e}")
+            self.db_conn = None
+        
         # Merge legacy contrib_scripts into ssr_contribs if used
         if self.config['contrib_scripts']:
             # Append unique items
@@ -129,8 +151,24 @@ class KatexSsrPlugin(BasePlugin):
         return config
 
     def _render_latex(self, latex, display_mode=False):
+        # Check cache first
+        latex_trimmed = latex.strip()
+        cache_key = None
+        if self.db_conn:
+            try:
+                # Create a unique hash for the content AND display mode
+                content_to_hash = f"{latex_trimmed}::{display_mode}"
+                cache_key = hashlib.sha256(content_to_hash.encode('utf-8')).hexdigest()
+                
+                cursor = self.db_conn.execute("SELECT html FROM katex_cache WHERE hash=?", (cache_key,))
+                row = cursor.fetchone()
+                if row:
+                    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 = {
@@ -146,11 +184,22 @@ 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':
-                    return result.get('html')
+                    html = result.get('html')
+                    # Save to cache
+                    if self.db_conn and cache_key:
+                        try:
+                            with self.db_conn:
+                                self.db_conn.execute(
+                                    "INSERT OR REPLACE INTO katex_cache (hash, html) VALUES (?, ?)",
+                                    (cache_key, html)
+                                )
+                        except Exception as e:
+                            print(f"Error saving to cache: {e}")
+                    return html, False
                 else:
                     print(f"KaTeX error: {result.get('message')}")
             except Exception as e:
@@ -158,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:
@@ -183,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']
@@ -234,6 +296,13 @@ class KatexSsrPlugin(BasePlugin):
             self.process.terminate()
             self.process.wait()
         
+        if self.db_conn:
+            try:
+                self.db_conn.close()
+            except:
+                pass
+            self.db_conn = None
+        
         # Copy assets if requested
         if self.config['embed_assets'] and self._local_dist_path:
             dest_dir = os.path.join(config['site_dir'], self.config['copy_assets_to'])

{mkdocs_katex_ssr-1.0.4 → mkdocs_katex_ssr-1.0.6}/mkdocs_katex_ssr.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-katex-ssr
-Version: 1.0.4
+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.4 → mkdocs_katex_ssr-1.0.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mkdocs-katex-ssr"
-version = "1.0.4"
+version = "1.0.6"
 description = "A MkDocs plugin for server-side rendering of KaTeX math."
 readme = "README.md"
 authors = [