docsforge 10.2.15__tar.gz → 10.3.0__tar.gz

{docsforge-10.2.15 → docsforge-10.3.0}/.gitignore

@@ -1,4 +1,5 @@
 .venv/
+venv/
 __pycache__/
 *.egg-info/
 dist/
@@ -10,3 +11,4 @@ build/
 .DS_Store
 # Downloaded during build
 docsforge/themes/material/templates/.icons/
+site/

{docsforge-10.2.15 → docsforge-10.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docsforge
-Version: 10.2.15
+Version: 10.3.0
 Summary: Self-contained unified documentation engine with Material theme.
 Project-URL: Documentation, https://qqshi13.github.io/docsforge-docs
 Project-URL: Source, https://github.com/QQSHI13/docsforge

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/__init__.py

@@ -4,7 +4,7 @@ DocsForge combines the ProperDocs build engine with the Material for MkDocs
 theme and plugins into a single, cohesive package.
 """
 
-__version__ = "10.2.15"
+__version__ = "10.3.0"
 __prog_name__ = "docsforge"
 
 # Install vendor compatibility shims

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/_vendor/mkdocs/structure/files.py

@@ -148,7 +148,7 @@ class Files:
 
         def filter(name):
             # '.*' filters dot files/dirs at root level whereas '*/.*' filters nested levels
-            patterns = ['.*', '*/.*', '*.py', '*.pyc', '*.html', '*readme*', 'mkdocs_theme.yml']
+            patterns = ['.*', '*/.*', '*.py', '*.pyc', '*.html', '*readme*', 'docsforge_theme.yml']
             # Exclude translation files
             patterns.append("locales/*")
             patterns.extend(f'*{x}' for x in utils.markdown_extensions)

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/_vendor/mkdocs/theme.py

@@ -128,7 +128,7 @@ class Theme(MutableMapping[str, Any]):
         self.dirs.append(theme_dir)
 
         try:
-            file_path = os.path.join(theme_dir, 'mkdocs_theme.yml')
+            file_path = os.path.join(theme_dir, 'docsforge_theme.yml')
             with open(file_path, 'rb') as f:
                 theme_config = yaml.load(f, SafeLoader)
         except OSError as e:

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/_vendor/properdocs/commands/get_deps.py

@@ -147,7 +147,7 @@ def get_deps(
     Args:
         config_file: Non-default docsforge.yml file - content as a buffer, or path.
         projects_file: File/buffer that declares all known DocsForge-related projects.
-            The file is in YAML format and contains `projects: [{mkdocs_theme:, mkdocs_plugin:, markdown_extension:}]
+            The file is in YAML format and contains `projects: [{docsforge_theme:, docsforge_plugin:, markdown_extension:}]
     """
     if isinstance(config_file, (str, os.PathLike)):
         config_file = os.path.abspath(config_file)

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/_vendor/properdocs/structure/files.py

@@ -149,7 +149,7 @@ class Files:
 
         def filter(name):
             # '.*' filters dot files/dirs at root level whereas '*/.*' filters nested levels
-            patterns = ['.*', '*/.*', '*.py', '*.pyc', '*.html', '*readme*', 'mkdocs_theme.yml']
+            patterns = ['.*', '*/.*', '*.py', '*.pyc', '*.html', '*readme*', 'docsforge_theme.yml']
             # Exclude translation files
             patterns.append("locales/*")
             patterns.extend(f'*{x}' for x in utils.markdown_extensions)

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/_vendor/properdocs/theme.py

@@ -129,7 +129,7 @@ class Theme(MutableMapping[str, Any]):
         self.dirs.append(theme_dir)
 
         try:
-            file_path = os.path.join(theme_dir, 'mkdocs_theme.yml')
+            file_path = os.path.join(theme_dir, 'docsforge_theme.yml')
             with open(file_path, 'rb') as f:
                 theme_config = yaml.load(f, SafeLoader)
         except OSError as e:

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/commands/get_deps.py

@@ -145,7 +145,7 @@ def get_deps(
     Args:
         config_file: Non-default docsforge.yml file - content as a buffer, or path.
         projects_file: File/buffer that declares all known DocsForge-related projects.
-            The file is in YAML format and contains `projects: [{mkdocs_theme:, mkdocs_plugin:, markdown_extension:}]
+            The file is in YAML format and contains `projects: [{docsforge_theme:, docsforge_plugin:, markdown_extension:}]
     """
     if isinstance(config_file, (str, os.PathLike)):
         config_file = os.path.abspath(config_file)

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/config/defaults.py

@@ -144,7 +144,7 @@ class ProperDocsConfig(base.Config):
             'nl2br',
             'sane_lists',
             'wikilinks',
-            'pymdownx.arithmatex',
+            {'pymdownx.arithmatex': {'generic': True}},
             'pymdownx.b64',
             'pymdownx.betterem',
             'pymdownx.caret',

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/structure/files.py

@@ -148,7 +148,7 @@ class Files:
 
         def filter(name):
             # '.*' filters dot files/dirs at root level whereas '*/.*' filters nested levels
-            patterns = ['.*', '*/.*', '*.py', '*.pyc', '*.html', '*readme*', 'mkdocs_theme.yml']
+            patterns = ['.*', '*/.*', '*.py', '*.pyc', '*.html', '*readme*', 'docsforge_theme.yml']
             # Exclude translation files
             patterns.append("locales/*")
             patterns.extend(f'*{x}' for x in utils.markdown_extensions)

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/theme.py

@@ -1,4 +1,3 @@
-# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
 # Copyright (c) 2026 QQ (Cyrus)
 #
 # This file is part of DocsForge.

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/themes/material/templates/assets/javascripts/sw.js

@@ -1,23 +1,11 @@
 /**
- * DocsForge Service Worker - Basic offline caching
- * Caches: HTML pages, CSS, JS, icons, KaTeX fonts
+ * DocsForge Service Worker - Runtime caching, no precache
+ * Caches assets as they're fetched, network-first for HTML
  */
 
-const CACHE_NAME = "docsforge-v1";
-
-// Assets to cache on install
-const PRECACHE_ASSETS = [
-  "assets/stylesheets/main.min.css",
-  "assets/stylesheets/palette.min.css",
-  "assets/javascripts/bundle.min.js",
-  "assets/katex/katex.min.css",
-  "assets/katex/katex.min.js",
-];
+const CACHE_NAME = "docsforge-v2";
 
 self.addEventListener("install", (e) => {
-  e.waitUntil(
-    caches.open(CACHE_NAME).then((cache) => cache.addAll(PRECACHE_ASSETS))
-  );
   self.skipWaiting();
 });
 

{docsforge-10.2.15 → docsforge-10.3.0}/docsforge/themes/material/templates/base.html

@@ -84,6 +84,12 @@
       {% include "partials/integrations/analytics.html" %}
     {% endblock %}
     {% block extrahead %}{% endblock %}
+    <style>
+      /* DocsForge: Fix blank spot in source repository when no facts */
+      .md-header__source { width: auto; }
+      .md-source { display: inline-flex; align-items: center; gap: 0.5rem; width: auto; }
+      .md-source__repository { max-width: none; }
+    </style>
   </head>
   {% set direction = config.theme.direction or lang.t("direction") %}
   {% if config.theme.palette %}
@@ -253,33 +259,178 @@
       </script>
     {% endblock %}
     {% block scripts %}
+      <script>
+        // Fix: pymdownx.tabbed generates labels without .tabbed-labels wrapper,
+        // but Material JS bundle expects it. Wrap them before bundle loads.
+        (function() {
+          function fixTabbedSets() {
+            document.querySelectorAll('.tabbed-set:not([data-fixed])').forEach(function(set) {
+              var labels = set.querySelectorAll(':scope > label');
+              if (labels.length && !set.querySelector('.tabbed-labels')) {
+                var wrapper = document.createElement('div');
+                wrapper.className = 'tabbed-labels';
+                labels.forEach(function(l) { wrapper.appendChild(l); });
+                set.insertBefore(wrapper, set.firstChild);
+                set.setAttribute('data-fixed', 'true');
+              }
+            });
+          }
+          // Fix existing elements immediately (before bundle init)
+          fixTabbedSets();
+          // Also run after instant navigation page switches (document$)
+          if (typeof document$ !== 'undefined' && document$.subscribe) {
+            document$.subscribe(function() { fixTabbedSets(); });
+          }
+          // Watch for dynamically added elements
+          var observer = new MutationObserver(function() { fixTabbedSets(); });
+          observer.observe(document.documentElement, {childList: true, subtree: true});
+        })();
+
+        // Fix: Ensure palette toggle is visible and clickable even if bundle.js crashes
+        (function() {
+          function fixPaletteVisibility() {
+            var scheme = document.body.getAttribute('data-md-color-scheme') || 'default';
+            var palette = document.querySelector('[data-md-component="palette"]');
+            if (!palette) return;
+            palette.querySelectorAll('label').forEach(function(label) {
+              var target = document.getElementById(label.getAttribute('for'));
+              if (target) {
+                var targetScheme = target.getAttribute('data-md-color-scheme');
+                label.hidden = (targetScheme === scheme);
+              }
+            });
+          }
+          
+          function setupPaletteClickHandlers() {
+            var palette = document.querySelector('[data-md-component="palette"]');
+            if (!palette) return;
+            // Only add if not already handled by bundle.js
+            if (palette.dataset.fixedPalette) return;
+            palette.dataset.fixedPalette = 'true';
+            
+            palette.querySelectorAll('label').forEach(function(label) {
+              label.addEventListener('click', function(e) {
+                e.preventDefault();
+                var targetId = label.getAttribute('for');
+                var target = document.getElementById(targetId);
+                if (!target) return;
+                
+                var newScheme = target.getAttribute('data-md-color-scheme');
+                var newPrimary = target.getAttribute('data-md-color-primary');
+                var newAccent = target.getAttribute('data-md-color-accent');
+                
+                // Update body
+                document.body.setAttribute('data-md-color-scheme', newScheme);
+                document.body.setAttribute('data-md-color-primary', newPrimary);
+                document.body.setAttribute('data-md-color-accent', newAccent);
+                
+                // Check the radio
+                target.checked = true;
+                
+                // Save to localStorage (use Material's __md_scope if available)
+                var scope = (typeof __md_scope !== 'undefined') ? __md_scope : new URL('.', location);
+                var key = scope.pathname + '.__palette';
+                var palette = null;
+                try { palette = JSON.parse(localStorage.getItem(key)); } catch(e) {}
+                if (!palette) palette = {};
+                palette.color = {
+                  media: '(prefers-color-scheme: ' + (newScheme === 'slate' ? 'dark' : 'light') + ')',
+                  scheme: newScheme,
+                  primary: newPrimary,
+                  accent: newAccent
+                };
+                localStorage.setItem(key, JSON.stringify(palette));
+                
+                // Update label visibility
+                fixPaletteVisibility();
+              });
+            });
+          }
+          
+          fixPaletteVisibility();
+          setupPaletteClickHandlers();
+          
+          if (typeof document$ !== 'undefined' && document$.subscribe) {
+            document$.subscribe(function() {
+              fixPaletteVisibility();
+              setupPaletteClickHandlers();
+            });
+          }
+        })();
+      </script>
       <script src="{{ 'assets/javascripts/bundle.79ae519e.min.js' | url }}"></script>
       <script src="{{ 'assets/katex/katex.min.js' | url }}"></script>
-      <script src="{{ 'assets/katex/mathtex-script-type.min.js' | url }}"></script>
       {% for script in config.extra_javascript %}
         {{ script | script_tag }}
       {% endfor %}
       <script>
-        // Re-render KaTeX after instant navigation page switches
-        if (typeof document$ !== "undefined") {
-          document$.subscribe(function() {
-            if (typeof katex !== "undefined") {
-              document.querySelectorAll(".arithmatex").forEach(function(el) {
-                var tex = el.textContent || el.innerText;
-                if (tex && tex.trim()) {
-                  try {
-                    katex.render(tex.trim(), el, {throwOnError: false, displayMode: el.classList.contains("arithmatex--block")});
-                  } catch(e) {}
-                }
-              });
+        // KaTeX rendering — supports both generic \(...\) and legacy <script type="math/tex"> formats
+        function renderKaTeX() {
+          if (typeof katex === 'undefined') return;
+          document.querySelectorAll('.arithmatex').forEach(function(el) {
+            var tex = null;
+            var isDisplay = el.classList.contains('arithmatex--block') || el.tagName === 'DIV';
+
+            // 1. Generic format: \( ... \) or \[ ... \]
+            var text = el.textContent.trim();
+            if (text.startsWith('\\(') && text.endsWith('\\)')) {
+              tex = text.slice(2, -2);
+              isDisplay = false;
+            } else if (text.startsWith('\\[') && text.endsWith('\\]')) {
+              tex = text.slice(2, -2);
+              isDisplay = true;
+            }
+
+            // 2. Legacy format: inner <script type="math/tex">
+            if (!tex) {
+              var script = el.querySelector('script[type^="math/tex"]');
+              if (script) {
+                tex = script.textContent;
+                if (script.type.indexOf('display') !== -1) isDisplay = true;
+              }
+            }
+
+            // 3. Data attribute (fallback)
+            if (!tex) {
+              tex = el.getAttribute('data-tex');
+            }
+
+            if (!tex || !tex.trim()) return;
+
+            // Clean up legacy cruft before rendering
+            el.querySelectorAll('.MathJax_Preview').forEach(function(p) { p.remove(); });
+            el.querySelectorAll('script[type^="math/tex"]').forEach(function(s) { s.remove(); });
+
+            // Clear and render
+            el.innerHTML = '';
+            try {
+              katex.render(tex.trim(), el, {throwOnError: false, displayMode: isDisplay});
+            } catch(e) {
+              el.textContent = tex.trim();
             }
           });
         }
+
+        // Render on initial load
+        if (document.readyState === 'loading') {
+          document.addEventListener('DOMContentLoaded', renderKaTeX);
+        } else {
+          renderKaTeX();
+        }
+
+        // Re-render after instant navigation
+        if (typeof document$ !== 'undefined' && document$.subscribe) {
+          document$.subscribe(renderKaTeX);
+        }
+
         // Register service worker for offline support
-        if ("serviceWorker" in navigator) {
+        if ('serviceWorker' in navigator) {
           var swUrl = "{{ 'assets/javascripts/sw.js' | url }}";
-          var swScope = swUrl.replace(/assets\/javascripts\/sw\.js$/, "");
-          navigator.serviceWorker.register(swUrl, {scope: swScope}).catch(function(){});
+          // SW scope must be at or under the script's directory
+          var swScope = swUrl.replace(/sw\.js$/, '');
+          navigator.serviceWorker.register(swUrl, {scope: swScope}).catch(function(e){
+            console.warn('SW registration failed:', e.message);
+          });
         }
       </script>
     {% endblock %}

{docsforge-10.2.15 → docsforge-10.3.0}/pyproject.toml

@@ -93,12 +93,9 @@ material = "docsforge.themes.material.templates"
 path = "docsforge/__init__.py"
 
 [tool.hatch.build.targets.sdist]
-include = ["/docsforge", "/README.md", "/LICENSE", "/scripts"]
+include = ["/docsforge", "/README.md", "/LICENSE"]
 
 [tool.hatch.build.targets.wheel]
 include = ["/docsforge"]
 # Include downloaded icons even though .icons/ is in .gitignore
 ignore-vcs = true
-
-[tool.hatch.build.hooks.custom]
-path = "scripts/hatch_build_hook.py"

docsforge-10.2.15/scripts/download_icons.py

@@ -1,66 +0,0 @@
-#!/usr/bin/env python3
-"""Download Material Icons from Material for MkDocs during package build.
-
-Material for MkDocs curates Google's Material Icons with naming that matches
-the theme templates. We fetch the latest matching version during build.
-"""
-
-import os
-import shutil
-import tarfile
-import tempfile
-import urllib.request
-from pathlib import Path
-
-
-def download_file(url: str, dest: Path) -> None:
-    """Download a file from URL to destination."""
-    print(f"Downloading {url}...")
-    urllib.request.urlretrieve(url, dest)
-    print(f"  -> {dest} ({dest.stat().st_size / 1024 / 1024:.1f}MB)")
-
-
-def download_material_icons() -> None:
-    """Download Material Icons from Material for MkDocs release."""
-    output_dir = Path("docsforge/themes/material/templates/.icons")
-    output_dir.mkdir(parents=True, exist_ok=True)
-
-    # Clean existing icons
-    if output_dir.exists():
-        for item in output_dir.iterdir():
-            if item.is_dir():
-                shutil.rmtree(item)
-            else:
-                item.unlink()
-
-    with tempfile.TemporaryDirectory() as tmpdir:
-        tmpdir = Path(tmpdir)
-        tar_path = tmpdir / "material.tar.gz"
-
-        # Download Material for MkDocs source (matches our vendored version)
-        url = "https://github.com/squidfunk/mkdocs-material/archive/refs/tags/9.7.6.tar.gz"
-        download_file(url, tar_path)
-
-        with tarfile.open(tar_path, "r:gz") as tar:
-            for member in tar.getmembers():
-                if member.name.startswith("mkdocs-material-9.7.6/material/templates/.icons/"):
-                    tar.extract(member, tmpdir)
-
-            src = tmpdir / "mkdocs-material-9.7.6/material/templates/.icons"
-            if src.exists():
-                for item in src.iterdir():
-                    dest = output_dir / item.name
-                    if item.is_dir():
-                        shutil.copytree(item, dest)
-                    else:
-                        shutil.copy2(item, dest)
-
-                count = sum(1 for _ in output_dir.rglob("*.svg"))
-                print(f"Extracted {count} icons")
-            else:
-                print("ERROR: Could not find icons in downloaded archive")
-                raise RuntimeError("Icon extraction failed")
-
-
-if __name__ == "__main__":
-    download_material_icons()

docsforge-10.2.15/scripts/hatch_build_hook.py

@@ -1,26 +0,0 @@
-"""Hatchling build hook to download Material Icons before building."""
-
-import subprocess
-import sys
-from pathlib import Path
-
-from hatchling.builders.hooks.plugin.interface import BuildHookInterface
-
-
-class BuildHook(BuildHookInterface):
-    def initialize(self, version, build_data):
-        """Download icons before building the wheel/sdist."""
-        root = Path(self.root)
-        script = root / "scripts" / "download_icons.py"
-        
-        if script.exists():
-            result = subprocess.run(
-                [sys.executable, str(script)],
-                cwd=str(root),
-                capture_output=True,
-                text=True,
-            )
-            if result.returncode != 0:
-                print(f"Warning: Icon download failed: {result.stderr}")
-            else:
-                print(result.stdout)