mkdocs-include-markdown-plugin 7.2.2__py3-none-any.whl → 7.3.0__py3-none-any.whl

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/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,

{mkdocs_include_markdown_plugin-7.2.2.dist-info → mkdocs_include_markdown_plugin-7.3.0.dist-info}/METADATA

@@ -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.dist-info → mkdocs_include_markdown_plugin-7.3.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
 mkdocs_include_markdown_plugin/__init__.py,sha256=ByOde15RQSHlZTmkepPSzIt0GzUIv_-GKORFDnxnOmc,193
 mkdocs_include_markdown_plugin/cache.py,sha256=iKZXwehr2Mus0NRcsKFRC6xMC4B5aG4pP-Yb1ooCQo4,3836
-mkdocs_include_markdown_plugin/config.py,sha256=AuJWYB_sAbRYpecXy6HHugQR09kKjlibcYX6kkWmBVc,1137
+mkdocs_include_markdown_plugin/config.py,sha256=rY4tZqDGLfL_Y5jNdKd5aEWFAKYY5ct75A4axXgIb-U,1187
 mkdocs_include_markdown_plugin/directive.py,sha256=K8L2ozzeCzSJ1N3owPAdETWEIM80kJCU2pygpYjg1F4,14752
-mkdocs_include_markdown_plugin/event.py,sha256=uzns7ARTwL8vH1VTqp6eSdZb8S9IQrxFIGUDk5VAH3o,26427
+mkdocs_include_markdown_plugin/event.py,sha256=ZHy-2acYaj-00WCHaR4WW8RkqiJRG2RbdJz8mT413cg,27458
 mkdocs_include_markdown_plugin/files_watcher.py,sha256=hu-63u8syl00mXP59vP_iqD7T1R9iU9JjiZOHDV5fas,298
 mkdocs_include_markdown_plugin/logger.py,sha256=nl63G4IJSt5mEYHbObuh7BmmowSv-aa1l_v9I257570,230
 mkdocs_include_markdown_plugin/placeholders.py,sha256=LBxFagmDDJ8le4AYrLJbt7WqYBu-kpJP6QqGWH7tDrs,1132
 mkdocs_include_markdown_plugin/plugin.py,sha256=t7eIgB3Z6XmcPOzlTqE15ajhY3oYPNKOZLb6D1_hx7I,4334
 mkdocs_include_markdown_plugin/process.py,sha256=TKT1V0VHGqLGeFDrsNoKroXmqkjqwPM22IRDwvsemtE,22776
 mkdocs_include_markdown_plugin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocs_include_markdown_plugin-7.2.2.dist-info/METADATA,sha256=d8TeVaRuDIEtFBCqZH_0130M1twMcULakZJRFKhCpoU,12697
-mkdocs_include_markdown_plugin-7.2.2.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
-mkdocs_include_markdown_plugin-7.2.2.dist-info/entry_points.txt,sha256=WEL5m7sw5ZMBwmdOs5S_9mGoZfLCaUDPkDKw7CUk16Q,96
-mkdocs_include_markdown_plugin-7.2.2.dist-info/licenses/LICENSE,sha256=Fyr5Goos1Rh671K_-S1AC7jTp1ng4xQdFjv-qbmCWLc,11365
-mkdocs_include_markdown_plugin-7.2.2.dist-info/RECORD,,
+mkdocs_include_markdown_plugin-7.3.0.dist-info/METADATA,sha256=IyyxjZ2hzzW366rIknx70GnykwJ1zU4R2SGYkSDuFkY,12888
+mkdocs_include_markdown_plugin-7.3.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+mkdocs_include_markdown_plugin-7.3.0.dist-info/entry_points.txt,sha256=WEL5m7sw5ZMBwmdOs5S_9mGoZfLCaUDPkDKw7CUk16Q,96
+mkdocs_include_markdown_plugin-7.3.0.dist-info/licenses/LICENSE,sha256=Fyr5Goos1Rh671K_-S1AC7jTp1ng4xQdFjv-qbmCWLc,11365
+mkdocs_include_markdown_plugin-7.3.0.dist-info/RECORD,,