mkdocs-include-markdown-plugin 7.2.2__tar.gz → 7.3.0__tar.gz

{mkdocs_include_markdown_plugin-7.2.2 → mkdocs_include_markdown_plugin-7.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-include-markdown-plugin
-Version: 7.2.2
+Version: 7.3.0
 Summary: Mkdocs Markdown includer plugin.
 Project-URL: Source, https://github.com/mondeja/mkdocs-include-markdown-plugin
 Project-URL: Documentation, https://github.com/mondeja/mkdocs-include-markdown-plugin#documentation
@@ -96,6 +96,7 @@ plugins:
       start: <!--start-->
       end: <!--end-->
       recursive: true
+      order: alpha-path
 ```
 
 #### `opening_tag` and `closing_tag`
@@ -176,6 +177,18 @@ plugins:
         include: replace
 ```
 
+<!-- mdpo-disable-next-line -->
+
+#### `include_from_url`
+
+Allow including content from URLs.
+
+```yaml
+plugins:
+  - include-markdown:
+      include_from_url: true
+```
+
 ### Reference
 
 This plugin provides two directives, one to include Markdown files and another

{mkdocs_include_markdown_plugin-7.2.2 → mkdocs_include_markdown_plugin-7.3.0}/README.md

@@ -61,6 +61,7 @@ plugins:
       start: <!--start-->
       end: <!--end-->
       recursive: true
+      order: alpha-path
 ```
 
 #### `opening_tag` and `closing_tag`
@@ -141,6 +142,18 @@ plugins:
         include: replace
 ```
 
+<!-- mdpo-disable-next-line -->
+
+#### `include_from_url`
+
+Allow including content from URLs.
+
+```yaml
+plugins:
+  - include-markdown:
+      include_from_url: true
+```
+
 ### Reference
 
 This plugin provides two directives, one to include Markdown files and another

{mkdocs_include_markdown_plugin-7.2.2 → mkdocs_include_markdown_plugin-7.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-include-markdown-plugin"
-version = "7.2.2"
+version = "7.3.0"
 description = "Mkdocs Markdown includer plugin."
 readme = "README.md"
 license = "Apache-2.0"

{mkdocs_include_markdown_plugin-7.2.2 → mkdocs_include_markdown_plugin-7.3.0}/src/mkdocs_include_markdown_plugin/config.py

@@ -35,3 +35,4 @@ class PluginConfig(Config):  # noqa: D101
             'include-markdown': 'include-markdown',
         },
     )
+    include_from_url = MkType(bool, default=True)

{mkdocs_include_markdown_plugin-7.2.2 → mkdocs_include_markdown_plugin-7.3.0}/src/mkdocs_include_markdown_plugin/event.py

@@ -55,6 +55,7 @@ if TYPE_CHECKING:  # pragma: no cover
 @dataclass
 class Settings:  # noqa: D101
     exclude: list[str] | None
+    include_from_url: bool = False
 
 
 def get_file_content(  # noqa: PLR0913, PLR0915
@@ -169,14 +170,25 @@ def get_file_content(  # noqa: PLR0913, PLR0915
             order,
         )
 
-        if is_url and 'order' in used_arguments:  # pragma: no cover
-            location = process.file_lineno_message(
-                page_src_path, docs_dir, directive_lineno(),
-            )
-            logger.warning(
-                f"Ignoring 'order' argument of 'include' directive"
-                f" at {location} because the included path is a URL",
-            )
+        if is_url:
+            if 'order' in used_arguments:  # pragma: no cover
+                location = process.file_lineno_message(
+                    page_src_path, docs_dir, directive_lineno(),
+                )
+                logger.warning(
+                    f"Ignoring 'order' argument of 'include' directive"
+                    f" at {location} because the included path is a URL",
+                )
+
+            if not settings.include_from_url:
+                location = process.file_lineno_message(
+                    page_src_path, docs_dir, directive_lineno(),
+                )
+                raise PluginError(
+                    f'Including from URL at {location} is not allowed because'
+                    ' include-markdown is configured with include_from_url set'
+                    ' to false',
+                )
 
         if not file_paths_to_include:
             location = process.file_lineno_message(
@@ -414,14 +426,25 @@ def get_file_content(  # noqa: PLR0913, PLR0915
             order,
         )
 
-        if is_url and 'order' in used_arguments:  # pragma: no cover
-            location = process.file_lineno_message(
-                page_src_path, docs_dir, directive_lineno(),
-            )
-            logger.warning(
-                f"Ignoring 'order' argument of 'include-markdown' directive"
-                f" at {location} because the included path is a URL",
-            )
+        if is_url:
+            if 'order' in used_arguments:  # pragma: no cover
+                location = process.file_lineno_message(
+                    page_src_path, docs_dir, directive_lineno(),
+                )
+                logger.warning(
+                    f"Ignoring 'order' argument of 'include-markdown' directive"
+                    f" at {location} because the included path is a URL",
+                )
+
+            if not settings.include_from_url:
+                location = process.file_lineno_message(
+                    page_src_path, docs_dir, directive_lineno(),
+                )
+                raise PluginError(
+                    f'Including from URL at {location} is not allowed because'
+                    ' include-markdown is configured with include_from_url set'
+                    ' to false',
+                )
 
         if not file_paths_to_include:
             location = process.file_lineno_message(
@@ -713,6 +736,7 @@ def on_page_markdown(
         },
         Settings(
             exclude=config.exclude,
+            include_from_url=config.include_from_url,
         ),
         files_watcher=plugin._files_watcher,
         http_cache=plugin._cache or http_cache,