fr-docs 2.1.0__tar.gz → 2.1.2__tar.gz

{fr_docs-2.1.0 → fr_docs-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fr-docs
-Version: 2.1.0
+Version: 2.1.2
 Summary: Fast static documentation generator with search, versioning, and zero-config setup
 License: # PolyForm Noncommercial License 1.0.0
         

{fr_docs-2.1.0 → fr_docs-2.1.2}/fr_docs/build.py

@@ -8,8 +8,11 @@ import argparse
 import concurrent.futures
 import json
 import os
+import re
 import shutil
+import subprocess
 import sys
+import tempfile
 from pathlib import Path
 
 import xxhash
@@ -42,6 +45,76 @@ def _compute_hash(data: str) -> str:
     return xxhash.xxh3_128_hexdigest(data.encode("utf-8"))
 
 
+def _minify_static_asset(config, src: Path, dst: Path, name: str) -> None:
+    """Minify a static asset in-place (JS via terser, CSS via html-minifier).
+
+    Falls back to a plain copy if the minifier is unavailable. CSS is minified
+    by wrapping it in a `<style>` tag (html-minifier-next only processes CSS
+    embedded in HTML) and stripping the wrapper afterwards.
+    """
+    repo_root = Path(config["_docs_dir"]).resolve().parent
+    node_modules = repo_root / "node_modules"
+
+    if name.endswith(".js"):
+        terser_bin = node_modules / ".bin" / "terser"
+        cmd = [
+            str(terser_bin) if terser_bin.exists() else "npx",
+            "--yes" if not terser_bin.exists() else "",
+            *(["terser"] if not terser_bin.exists() else []),
+            str(src),
+            "--compress",
+            "warnings=false",
+            "--mangle",
+            "--output",
+            str(dst),
+        ]
+        cmd = [c for c in cmd if c]
+        result = subprocess.run(cmd, capture_output=True, text=True, check=False, cwd=str(repo_root))
+        if result.returncode != 0 or not dst.exists() or dst.stat().st_size == 0:
+            print(f"  ! minify failed for {name}, copying raw: {result.stderr[-300:]}")
+            shutil.copyfile(src, dst)
+        return
+
+    # CSS: html-minifier-next only minifies CSS embedded in HTML, so wrap the
+    # stylesheet in a <style> tag, minify, then strip the wrapper.
+    minifier_bin = node_modules / ".bin" / "html-minifier-next"
+    raw_css = src.read_text(encoding="utf-8")
+    wrapped = f"<style>{raw_css}</style>"
+    wrapper = Path(tempfile.mkstemp(suffix=".html")[1])
+    min_out = Path(tempfile.mkstemp(suffix=".html")[1])
+    try:
+        wrapper.write_text(wrapped, encoding="utf-8")
+        cmd = [
+            str(minifier_bin) if minifier_bin.exists() else "npx",
+            "--yes" if not minifier_bin.exists() else "",
+            *(["html-minifier-next"] if not minifier_bin.exists() else ""),
+            "--minify-css=true",
+            "--remove-comments",
+            "--output",
+            str(min_out),
+            str(wrapper),
+        ]
+        cmd = [c for c in cmd if c]
+        result = subprocess.run(cmd, capture_output=True, text=True, check=False, cwd=str(repo_root))
+        if result.returncode == 0 and min_out.exists():
+            out = min_out.read_text(encoding="utf-8")
+            m = re.search(r"<style>([\s\S]*)</style>", out)
+            if m:
+                dst.write_text(m.group(1), encoding="utf-8")
+                return
+        print(f"  ! minify failed for {name}, copying raw: {result.stderr[-300:]}")
+    finally:
+        try:
+            wrapper.unlink()
+        except OSError:
+            pass
+        try:
+            min_out.unlink()
+        except OSError:
+            pass
+    shutil.copyfile(src, dst)
+
+
 class BuildCache:
     """Manage caching of build data to avoid unnecessary regeneration."""
 
@@ -287,7 +360,7 @@ def main(argv=None):
         config["_source_files"] = source_files
         print(f"   Found {len(source_files)} source files")
 
-    # Copy static assets
+    # Copy static assets (minifying JS/CSS when production)
     docs_path = Path(config["_docs_dir"])
     os.makedirs(Path(config["_out_dir"]), exist_ok=True)
     for legacy_name in (
@@ -303,7 +376,10 @@ def main(argv=None):
         dst = Path(config["_out_dir"]) / name
 
         try:
-            shutil.copyfile(src, dst)
+            if config.get("production", False) and name.endswith((".js", ".css")):
+                _minify_static_asset(config, src, dst, name)
+            else:
+                shutil.copyfile(src, dst)
         except FileNotFoundError:
             print(f"File not found: {os.getcwd()}, {src}->{dst}")
         except OSError as e:

{fr_docs-2.1.0 → fr_docs-2.1.2}/fr_docs/html_pipeline.py

@@ -81,6 +81,18 @@ def _render_template_placeholders(config):
       <input type="text" id="header-search" placeholder="Search docs… (Ctrl+K)" autocomplete="off">
       <div id="search-results" class="search-results"></div>"""
 
+    def _get_search_preloads_html():
+        if not feature_enabled(config, "search"):
+            return ""
+        sp = output_href("", config)
+        return (
+            f'<link rel="preload" as="fetch" href="{sp}search_index.zst" crossorigin>\n'
+            f'    <link rel="preload" as="fetch" href="{sp}symbol_index.zst" crossorigin>\n'
+            f'    <link rel="preload" as="fetch" href="{sp}file_index.zst" crossorigin>\n'
+            f'    <link rel="preload" as="fetch" href="{sp}git_meta.zst" crossorigin>\n'
+            f'    <link rel="modulepreload" href="https://cdn.jsdelivr.net/npm/fzstd@0.1.1/umd/index.min.js">'
+        )
+
     return {
         "site_prefix": output_href("", config),
         "page_title": "",
@@ -95,6 +107,7 @@ def _render_template_placeholders(config):
         "subtitle_html": "",
         "body": "",
         "search_index_inline": "",
+        "search_preloads": _get_search_preloads_html(),
         "copyright_year": _get_copyright_year(),
         "copyright_holder": _get_copyright_holder(),
     }

{fr_docs-2.1.0 → fr_docs-2.1.2}/fr_docs/template.py

@@ -17,11 +17,14 @@ TEMPLATE = """\
   <meta property="og:site_name" content="{project_name} Docs">
   <meta name="theme-color" content="#6366f1">
   <meta name="color-scheme" content="dark">
+  <link rel="stylesheet" href="{site_prefix}style.css">
   <link rel="icon" href="{site_prefix}favicon.svg" type="image/svg+xml">
   <link rel="preconnect" href="https://fonts.googleapis.com">
   <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-  <link href="https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,400..800&family=JetBrains+Mono:wght@400..700&display=swap" rel="stylesheet">
-  <link rel="stylesheet" href="{site_prefix}style.css">
+<link href="https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,400..800&family=JetBrains+Mono:wght@400..700&display=optional" rel="stylesheet">
+<link rel="preload" as="font" href="https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmM.woff2" type="font/woff2" crossorigin>
+<link rel="preload" as="font" href="https://fonts.gstatic.com/s/inter/v20/UcCo3FwrK3iLTcviYwYZ8UA3.woff2" type="font/woff2" crossorigin>
+<link rel="preload" as="font" href="https://fonts.gstatic.com/s/jetbrainsmono/v24/tDbv2o-flEEny0FZhsfKu5WU4zr3E_BX0P.woff2" type="font/woff2" crossorigin>
 </head>
 <body>
   <!-- Header -->
@@ -72,6 +75,7 @@ TEMPLATE = """\
   </button>
 
     {search_index_inline}
+    {search_preloads}
     <script id="code-refs-data" type="application/json">{code_refs_json}</script>
     <script id="search-config" type="application/json">{search_config_json}</script>
     <script src="{site_prefix}script.js" defer></script>

{fr_docs-2.1.0 → fr_docs-2.1.2}/fr_docs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fr-docs
-Version: 2.1.0
+Version: 2.1.2
 Summary: Fast static documentation generator with search, versioning, and zero-config setup
 License: # PolyForm Noncommercial License 1.0.0
         

{fr_docs-2.1.0 → fr_docs-2.1.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fr-docs"
-version = "2.1.0"
+version = "2.1.2"
 description = "Fast static documentation generator with search, versioning, and zero-config setup"
 requires-python = ">=3.14"
 dependencies = [