Updated archive creation hook

Author: squidfunk

examples/__init__.py

@@ -47,8 +47,3 @@ def transform(project: MkDocsConfig, config: MkDocsConfig):
     # Inherit settings for theme
     merge(project.theme["icon"], config.theme["icon"])
     project.theme["features"].extend(config.theme["features"])
-
-    root = os.path.dirname(config.config_file_path)
-    project.hooks = [
-        os.path.join(root, "hooks", "zip.py")
-    ]

examples/tags/docs/README.md

@@ -12,16 +12,3 @@ This example includes the following pages:
   [HTML]: demo/tags.md#html
   [JavaScript]: demo/tags.md#javascript
   [CSS]: demo/tags.md#css
-
-Download example as archive:
-
-[Download .zip][Download]{ .md-button .md-button--primary }
-
-Unzip archive, change to the folder and enter:
-
-``` bash
-pip install -r requirements.txt
-mkdocs serve
-```
-
-  [Download]: ../../download/tags.zip

hooks/archive.py

@@ -0,0 +1,72 @@
+# Copyright (c) 2016-2023 Martin Donath <[email protected]>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+import logging
+import os
+
+from glob import iglob
+from mkdocs.config.defaults import MkDocsConfig
+from pathspec.gitignore import GitIgnoreSpec
+from zipfile import ZipFile, ZIP_DEFLATED
+
+# -----------------------------------------------------------------------------
+# Hooks
+# -----------------------------------------------------------------------------
+
+# Create archives for all examples
+def on_post_build(config: MkDocsConfig):
+
+    # Read files to ignore from .gitignore
+    with open(".gitignore") as f:
+        spec = GitIgnoreSpec.from_lines([
+            line for line in f.read().split("\n")
+                if line and not line.startswith("#")
+        ])
+
+    # Create archives for each example
+    for file in iglob("examples/*/mkdocs.yml", recursive = True):
+        base = os.path.dirname(file)
+
+        # Compute archive name and path
+        example = os.path.basename(base)
+        archive = os.path.join(config.site_dir, f"{example}.zip")
+
+        # Start archive creation
+        log.info(f"Creating archive '{example}.zip'")
+        with ZipFile(archive, "w", ZIP_DEFLATED, False) as f:
+            for name in spec.match_files(os.listdir(base), negate = True):
+                path = os.path.join(base, name)
+                if os.path.isdir(path):
+                    path = os.path.join(path, "**")
+
+                # Find all files recursively and add them to the archive
+                for file in iglob(path, recursive = True):
+                    location = os.path.join(name, os.path.relpath(file, base))
+
+                    # Add file to archive
+                    log.debug(f"+ '{file}'")
+                    f.write(file, location)
+
+# -----------------------------------------------------------------------------
+# Data
+# -----------------------------------------------------------------------------
+
+# Set up logging
+log = logging.getLogger("mkdocs.material.examples")

hooks/zip.py

@@ -52,6 +52,10 @@ plugins:
       projects_dir: examples
       projects_config_transform: !!python/name:examples.transform
 
+# Hooks
+hooks:
+  - hooks/archive.py
+
 # Customization
 extra:
   analytics: