mkdocs-rangefind 0.1.0__tar.gz → 0.2.0__tar.gz

{mkdocs_rangefind-0.1.0 → mkdocs_rangefind-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-rangefind
-Version: 0.1.0
+Version: 0.2.0
 Summary: MkDocs plugin that builds a Rangefind static search index and injects the search widget after every build.
 Project-URL: Homepage, https://github.com/xjodoin/rangefind
 Project-URL: Repository, https://github.com/xjodoin/rangefind

{mkdocs_rangefind-0.1.0 → mkdocs_rangefind-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "mkdocs-rangefind"
-version = "0.1.0"
+version = "0.2.0"
 description = "MkDocs plugin that builds a Rangefind static search index and injects the search widget after every build."
 readme = "README.md"
 requires-python = ">=3.8"

{mkdocs_rangefind-0.1.0 → mkdocs_rangefind-0.2.0}/src/mkdocs_rangefind/plugin.py

@@ -57,6 +57,11 @@ class RangefindPlugin(BasePlugin):
         # Command used to run the Rangefind CLI. "npx" resolves the local
         # `rangefind` install; can be pointed at a specific binary in CI.
         ("node_command", config_options.Type(str, default="npx")),
+        # Path to an ES module whose default export is an async
+        # function(docs) run on the crawled documents before indexing
+        # (embeddings, metadata, ...); may also export `config` overrides.
+        # Relative paths resolve from the project directory.
+        ("enrich", config_options.Type(str, default="")),
         # Where to place the <rangefind-search> element:
         #   "body_end" (default) - injected right before </body> on every page.
         #   "manual"             - not injected; you hand-place it in a theme
@@ -103,6 +108,9 @@ class RangefindPlugin(BasePlugin):
             "--base-url",
             base_url,
         ]
+        if self.config["enrich"]:
+            enrich_abs = os.path.join(project_dir, self.config["enrich"])
+            command.extend(["--enrich", enrich_abs])
         log.info("Building Rangefind index: %s", " ".join(command))
         try:
             result = subprocess.run(