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

{mkdocs_include_markdown_plugin-7.2.0 → mkdocs_include_markdown_plugin-7.2.2}/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2017-2025 Joe Rickerby and contributors
+   Copyright 2017-2026 Joe Rickerby and contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-include-markdown-plugin
-Version: 7.2.0
+Version: 7.2.2
 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
@@ -181,6 +181,8 @@ plugins:
 This plugin provides two directives, one to include Markdown files and another
 to include files of any type.
 
+#### Common arguments
+
 Paths of included files can be either:
 
 - URLs to include remote content.
@@ -199,34 +201,27 @@ single `'` quotes, which can be escaped prepending them a `\` character as
 The arguments **start** and **end** may contain usual (Python-style) escape
 sequences like `\n` to match against newlines.
 
-<!-- mdpo-disable-next-line -->
-
-#### **`include-markdown`**
-
-Includes Markdown files content, optionally using two delimiters to filter the
-content to include.
-
-- <a name="include-markdown_start" href="#include-markdown_start">#</a>
+- <a name="include_start" href="#include_start">#</a>
   **start**: Delimiter that marks the beginning of the content to include.
-- <a name="include-markdown_end" href="#include-markdown_end">#</a>
+- <a name="include_end" href="#include_end">#</a>
   **end**: Delimiter that marks the end of the content to include.
-- <a name="include-markdown_preserve-includer-indent" href="#include-markdown_preserve-includer-indent">#</a>
+- <a name="include_preserve-includer-indent" href="#include_preserve-includer-indent">#</a>
   **preserve-includer-indent** (_true_): When this option is enabled (default),
   every line of the content to include is indented with the same number of
   spaces used to indent the includer `{% %}` template. Possible values are
   `true` and `false`.
-- <a name="include-markdown_dedent" href="#include-markdown_dedent">#</a>
+- <a name="include_dedent" href="#include_dedent">#</a>
   **dedent** (_false_): If enabled, the included content will be dedented.
-- <a name="include-markdown_exclude" href="#include-markdown_exclude">#</a>
+- <a name="include_exclude" href="#include_exclude">#</a>
   **exclude**: Specify with a glob which files should be ignored. Only useful
   when passing globs to include multiple files.
-- <a name="include-markdown_trailing-newlines" href="#include-markdown_trailing-newlines">#</a>
+- <a name="include_trailing-newlines" href="#include_trailing-newlines">#</a>
   **trailing-newlines** (_true_): When this option is disabled, the trailing newlines
   found in the content to include are stripped. Possible values are `true` and `false`.
-- <a name="include-markdown_recursive" href="#include-markdown_recursive">#</a>
+- <a name="include_recursive" href="#include_recursive">#</a>
   **recursive** (_true_): When this option is disabled, included files are not
   processed for recursive includes. Possible values are `true` and `false`.
-- <a name="include-markdown_order" href="#include-markdown_order">#</a>
+- <a name="include_order" href="#include_order">#</a>
   **order** (_'alpha-path'_): Define the order in which multiple files are included
   when using globs. Possible values are:
   - A combination of an optional order type and an optional order by separated
@@ -241,20 +236,28 @@ content to include.
       - `'path'` (default): Order by full file path.
       - `'name'`: Order by file name only.
       - `'extension'`: Order by file extension.
-  - A combination of an optional prefix hyphen to denote ascending order and
-    one of the following values in the form `[-]<value>` where `<value>` is one of:
+  - A combination of an optional prefix hyphen to denote ascending order and one
+    of the following values in the form `[-]<value>` where `<value>` is one of:
     - `'size'`: Order by file size.
     - `'mtime'`: Order by file modification time.
     - `'ctime'`: Order by file creation time (or the last metadata change time
       on Unix systems).
     - `'atime'`: Order by file last access time.
+    - `'system'`: Order provided by the operating system. This is the same as not
+      specifying any order and relying on the default order of the filesystem.
+      This may be different between operating systems, so use it with care.
   - `'random'`: Random order.
-  - `'system'`: Order provided by the operating system. This is the same as not
-    specifying any order and relying on the default order of the filesystem. This
-    may be different between operating systems, so use it with care.
-- <a name="include-markdown_encoding" href="#include-markdown_encoding">#</a>
+- <a name="include_encoding" href="#include_encoding">#</a>
   **encoding** (_'utf-8'_): Specify the encoding of the included file.
   If not defined `'utf-8'` will be used.
+
+<!-- mdpo-disable-next-line -->
+
+#### **`include-markdown`**
+
+Includes Markdown files content, optionally using two delimiters to filter the
+content to include.
+
 - <a name="include-markdown_rewrite-relative-urls" href="#include-markdown_rewrite-relative-urls">#</a>
   **rewrite-relative-urls** (_true_): When this option is enabled (default),
   Markdown links and images in the content that are specified by a relative URL
@@ -331,56 +334,6 @@ content to include.
 
 Includes the content of a file or a group of files.
 
-- <a name="include_start" href="#include_start">#</a>
-  **start**: Delimiter that marks the beginning of the content to include.
-- <a name="include_end" href="#include_end">#</a>
-  **end**: Delimiter that marks the end of the content to include.
-- <a name="include_preserve-includer-indent" href="#include_preserve-includer-indent">#</a>
-  **preserve-includer-indent** (_true_): When this option is enabled (default),
-  every line of the content to include is indented with the same number of
-  spaces used to indent the includer `{% %}` template. Possible values are
-  `true` and `false`.
-- <a name="include_dedent" href="#include_dedent">#</a>
-  **dedent** (_false_): If enabled, the included content will be dedented.
-- <a name="include_exclude" href="#include_exclude">#</a>
-  **exclude**: Specify with a glob which files should be ignored. Only useful
-  when passing globs to include multiple files.
-- <a name="include_trailing-newlines" href="#include_trailing-newlines">#</a>
-  **trailing-newlines** (_true_): When this option is disabled, the trailing newlines
-  found in the content to include are stripped. Possible values are `true` and `false`.
-- <a name="include_recursive" href="#include_recursive">#</a>
-  **recursive** (_true_): When this option is disabled, included files are not
-  processed for recursive includes. Possible values are `true` and `false`.
-- <a name="include_order" href="#include_order">#</a>
-  **order** (_'alpha-path'_): Define the order in which multiple files are included
-  when using globs. Possible values are:
-  - A combination of an optional order type and an optional order by separated
-    by a hyphen (`-`), and optionally prefixed by a hyphen (`-`) to indicate
-    ascending order. If an order type or an order by is not specified, the defaults
-    are used. It follows the form:
-    `[-]<order_type>-<order_by>` where:
-    - **Order type**:
-      - `'alpha'` (default): Alphabetical order.
-      - `'natural'`: Natural order, so that e.g. `file2.md` comes before `file10.md`.
-    - **Order by**:
-      - `'path'` (default): Order by full file path.
-      - `'name'`: Order by file name only.
-      - `'extension'`: Order by file extension.
-  - A combination of an optional prefix hyphen to denote ascending order and
-    one of the following values in the form `[-]<value>` where `<value>` is one of:
-    - `'size'`: Order by file size.
-    - `'mtime'`: Order by file modification time.
-    - `'ctime'`: Order by file creation time (or the last metadata change time
-      on Unix systems).
-    - `'atime'`: Order by file last access time.
-  - `'random'`: Random order.
-  - `'system'`: Order provided by the operating system. This is the same as not
-    specifying any order and relying on the default order of the filesystem. This
-    may be different between operating systems, so use it with care.
-- <a name="include_encoding" href="#include_encoding">#</a>
-  **encoding** (_'utf-8'_): Specify the encoding of the included file.
-  If not defined `'utf-8'` will be used.
-
 ##### Examples
 
 ```jinja

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

@@ -146,6 +146,8 @@ plugins:
 This plugin provides two directives, one to include Markdown files and another
 to include files of any type.
 
+#### Common arguments
+
 Paths of included files can be either:
 
 - URLs to include remote content.
@@ -164,34 +166,27 @@ single `'` quotes, which can be escaped prepending them a `\` character as
 The arguments **start** and **end** may contain usual (Python-style) escape
 sequences like `\n` to match against newlines.
 
-<!-- mdpo-disable-next-line -->
-
-#### **`include-markdown`**
-
-Includes Markdown files content, optionally using two delimiters to filter the
-content to include.
-
-- <a name="include-markdown_start" href="#include-markdown_start">#</a>
+- <a name="include_start" href="#include_start">#</a>
   **start**: Delimiter that marks the beginning of the content to include.
-- <a name="include-markdown_end" href="#include-markdown_end">#</a>
+- <a name="include_end" href="#include_end">#</a>
   **end**: Delimiter that marks the end of the content to include.
-- <a name="include-markdown_preserve-includer-indent" href="#include-markdown_preserve-includer-indent">#</a>
+- <a name="include_preserve-includer-indent" href="#include_preserve-includer-indent">#</a>
   **preserve-includer-indent** (_true_): When this option is enabled (default),
   every line of the content to include is indented with the same number of
   spaces used to indent the includer `{% %}` template. Possible values are
   `true` and `false`.
-- <a name="include-markdown_dedent" href="#include-markdown_dedent">#</a>
+- <a name="include_dedent" href="#include_dedent">#</a>
   **dedent** (_false_): If enabled, the included content will be dedented.
-- <a name="include-markdown_exclude" href="#include-markdown_exclude">#</a>
+- <a name="include_exclude" href="#include_exclude">#</a>
   **exclude**: Specify with a glob which files should be ignored. Only useful
   when passing globs to include multiple files.
-- <a name="include-markdown_trailing-newlines" href="#include-markdown_trailing-newlines">#</a>
+- <a name="include_trailing-newlines" href="#include_trailing-newlines">#</a>
   **trailing-newlines** (_true_): When this option is disabled, the trailing newlines
   found in the content to include are stripped. Possible values are `true` and `false`.
-- <a name="include-markdown_recursive" href="#include-markdown_recursive">#</a>
+- <a name="include_recursive" href="#include_recursive">#</a>
   **recursive** (_true_): When this option is disabled, included files are not
   processed for recursive includes. Possible values are `true` and `false`.
-- <a name="include-markdown_order" href="#include-markdown_order">#</a>
+- <a name="include_order" href="#include_order">#</a>
   **order** (_'alpha-path'_): Define the order in which multiple files are included
   when using globs. Possible values are:
   - A combination of an optional order type and an optional order by separated
@@ -206,20 +201,28 @@ content to include.
       - `'path'` (default): Order by full file path.
       - `'name'`: Order by file name only.
       - `'extension'`: Order by file extension.
-  - A combination of an optional prefix hyphen to denote ascending order and
-    one of the following values in the form `[-]<value>` where `<value>` is one of:
+  - A combination of an optional prefix hyphen to denote ascending order and one
+    of the following values in the form `[-]<value>` where `<value>` is one of:
     - `'size'`: Order by file size.
     - `'mtime'`: Order by file modification time.
     - `'ctime'`: Order by file creation time (or the last metadata change time
       on Unix systems).
     - `'atime'`: Order by file last access time.
+    - `'system'`: Order provided by the operating system. This is the same as not
+      specifying any order and relying on the default order of the filesystem.
+      This may be different between operating systems, so use it with care.
   - `'random'`: Random order.
-  - `'system'`: Order provided by the operating system. This is the same as not
-    specifying any order and relying on the default order of the filesystem. This
-    may be different between operating systems, so use it with care.
-- <a name="include-markdown_encoding" href="#include-markdown_encoding">#</a>
+- <a name="include_encoding" href="#include_encoding">#</a>
   **encoding** (_'utf-8'_): Specify the encoding of the included file.
   If not defined `'utf-8'` will be used.
+
+<!-- mdpo-disable-next-line -->
+
+#### **`include-markdown`**
+
+Includes Markdown files content, optionally using two delimiters to filter the
+content to include.
+
 - <a name="include-markdown_rewrite-relative-urls" href="#include-markdown_rewrite-relative-urls">#</a>
   **rewrite-relative-urls** (_true_): When this option is enabled (default),
   Markdown links and images in the content that are specified by a relative URL
@@ -296,56 +299,6 @@ content to include.
 
 Includes the content of a file or a group of files.
 
-- <a name="include_start" href="#include_start">#</a>
-  **start**: Delimiter that marks the beginning of the content to include.
-- <a name="include_end" href="#include_end">#</a>
-  **end**: Delimiter that marks the end of the content to include.
-- <a name="include_preserve-includer-indent" href="#include_preserve-includer-indent">#</a>
-  **preserve-includer-indent** (_true_): When this option is enabled (default),
-  every line of the content to include is indented with the same number of
-  spaces used to indent the includer `{% %}` template. Possible values are
-  `true` and `false`.
-- <a name="include_dedent" href="#include_dedent">#</a>
-  **dedent** (_false_): If enabled, the included content will be dedented.
-- <a name="include_exclude" href="#include_exclude">#</a>
-  **exclude**: Specify with a glob which files should be ignored. Only useful
-  when passing globs to include multiple files.
-- <a name="include_trailing-newlines" href="#include_trailing-newlines">#</a>
-  **trailing-newlines** (_true_): When this option is disabled, the trailing newlines
-  found in the content to include are stripped. Possible values are `true` and `false`.
-- <a name="include_recursive" href="#include_recursive">#</a>
-  **recursive** (_true_): When this option is disabled, included files are not
-  processed for recursive includes. Possible values are `true` and `false`.
-- <a name="include_order" href="#include_order">#</a>
-  **order** (_'alpha-path'_): Define the order in which multiple files are included
-  when using globs. Possible values are:
-  - A combination of an optional order type and an optional order by separated
-    by a hyphen (`-`), and optionally prefixed by a hyphen (`-`) to indicate
-    ascending order. If an order type or an order by is not specified, the defaults
-    are used. It follows the form:
-    `[-]<order_type>-<order_by>` where:
-    - **Order type**:
-      - `'alpha'` (default): Alphabetical order.
-      - `'natural'`: Natural order, so that e.g. `file2.md` comes before `file10.md`.
-    - **Order by**:
-      - `'path'` (default): Order by full file path.
-      - `'name'`: Order by file name only.
-      - `'extension'`: Order by file extension.
-  - A combination of an optional prefix hyphen to denote ascending order and
-    one of the following values in the form `[-]<value>` where `<value>` is one of:
-    - `'size'`: Order by file size.
-    - `'mtime'`: Order by file modification time.
-    - `'ctime'`: Order by file creation time (or the last metadata change time
-      on Unix systems).
-    - `'atime'`: Order by file last access time.
-  - `'random'`: Random order.
-  - `'system'`: Order provided by the operating system. This is the same as not
-    specifying any order and relying on the default order of the filesystem. This
-    may be different between operating systems, so use it with care.
-- <a name="include_encoding" href="#include_encoding">#</a>
-  **encoding** (_'utf-8'_): Specify the encoding of the included file.
-  If not defined `'utf-8'` will be used.
-
 ##### Examples
 
 ```jinja

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

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

{mkdocs_include_markdown_plugin-7.2.0 → mkdocs_include_markdown_plugin-7.2.2}/src/mkdocs_include_markdown_plugin/directive.py

@@ -140,7 +140,7 @@ def _maybe_arguments_iter(arguments_string: str) -> Iterable[str]:
     inside_string = False
     escaping = False
     opening_argument = False  # whether we are at the beginning of an argument
-    current_value = ''
+    current_value: list[str] = []
 
     for c in arguments_string:
         if inside_string:
@@ -153,24 +153,25 @@ def _maybe_arguments_iter(arguments_string: str) -> Iterable[str]:
             else:
                 escaping = False
         elif c == '=':
+            current_value_str = ''.join(current_value)
             new_current_value = ''
-            for ch in reversed(current_value):
+            for ch in reversed(current_value_str):
                 if ch in string.whitespace:
-                    current_value = new_current_value[::-1]
+                    current_value_str = new_current_value[::-1]
                     break
                 new_current_value += ch
-            yield current_value
-            current_value = ''
+            yield current_value_str
+            current_value = []
             opening_argument = True
         elif opening_argument:
             opening_argument = False
             if c in ('"', "'"):
                 current_string_opening = c
                 inside_string = True
-                current_value += c
-                current_value += c
+                current_value.append(c)
+                current_value.append(c)
         else:
-            current_value += c
+            current_value.append(c)
 
 
 def warn_invalid_directive_arguments(

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

@@ -545,7 +545,7 @@ def get_file_content(  # noqa: PLR0913, PLR0915
         # but they have been specified, so the warning(s) must be raised
         expected_but_any_found = [start is not None, end is not None]
 
-        text_to_include = ''
+        text_to_include_parts = []
         for file_path in file_paths_to_include:
             if process.is_url(filename):
                 new_text_to_include = process.read_url(
@@ -621,11 +621,10 @@ def get_file_content(  # noqa: PLR0913, PLR0915
                 new_text_to_include
             ):
                 lines = new_text_to_include.splitlines(keepends=True)
-                new_text_to_include = lines[0]
+                indented_lines = [lines[0]]
                 for i in range(1, len(lines)):
-                    new_text_to_include += (
-                        filled_includer_indent + lines[i]
-                    )
+                    indented_lines.append(filled_includer_indent + lines[i])
+                new_text_to_include = ''.join(indented_lines)
 
             if offset:
                 new_text_to_include = process.increase_headings_offset(
@@ -633,7 +632,9 @@ def get_file_content(  # noqa: PLR0913, PLR0915
                     offset=offset + cumulative_heading_offset,
                 )
 
-            text_to_include += new_text_to_include
+            text_to_include_parts.append(new_text_to_include)
+
+        text_to_include = ''.join(text_to_include_parts)
 
         # warn if expected start or ends haven't been found in included content
         for i, delimiter_name in enumerate(['start', 'end']):

{mkdocs_include_markdown_plugin-7.2.0 → mkdocs_include_markdown_plugin-7.2.2}/src/mkdocs_include_markdown_plugin/process.py

@@ -174,10 +174,12 @@ def transform_p_by_p_skipping_codeblocks(  # noqa: PLR0912, PLR0915
     _maybe_icodeblock_lines: list[str] = []
     _previous_line_was_empty = False
 
-    lines, current_paragraph = ([], '')
+    lines = []
+    current_paragraph_lines: list[str] = []
 
     def process_current_paragraph() -> None:
-        lines.extend(func(current_paragraph).splitlines(keepends=True))
+        lines.extend(func(''.join(current_paragraph_lines),
+                          ).splitlines(keepends=True))
 
     # The next implementation takes into account that indented code
     # blocks must be surrounded by newlines as per the CommonMark
@@ -191,25 +193,24 @@ def transform_p_by_p_skipping_codeblocks(  # noqa: PLR0912, PLR0915
             if lstripped_line.startswith(('```', '~~~')):
                 _current_fcodeblock_delimiter = lstripped_line[:3]
                 process_current_paragraph()
-                current_paragraph = ''
+                current_paragraph_lines = []
                 lines.append(line)
             elif line.startswith('    '):
                 if not lstripped_line or _maybe_icodeblock_lines:
                     # maybe enter indented codeblock
                     _maybe_icodeblock_lines.append(line)
                 else:
-                    current_paragraph += line
+                    current_paragraph_lines.append(line)
             elif _maybe_icodeblock_lines:
                 process_current_paragraph()
-                current_paragraph = ''
+                current_paragraph_lines = []
                 if not _previous_line_was_empty:
                     # wasn't an indented code block
-                    for line_ in _maybe_icodeblock_lines:
-                        current_paragraph += line_
+                    current_paragraph_lines.extend(_maybe_icodeblock_lines)
                     _maybe_icodeblock_lines = []
-                    current_paragraph += line
+                    current_paragraph_lines.append(line)
                     process_current_paragraph()
-                    current_paragraph = ''
+                    current_paragraph_lines = []
                 else:
                     # exit indented codeblock
                     for line_ in _maybe_icodeblock_lines:
@@ -217,7 +218,7 @@ def transform_p_by_p_skipping_codeblocks(  # noqa: PLR0912, PLR0915
                     _maybe_icodeblock_lines = []
                     lines.append(line)
             else:
-                current_paragraph += line
+                current_paragraph_lines.append(line)
             _previous_line_was_empty = not lstripped_line
         else:
             lines.append(line)
@@ -230,14 +231,13 @@ def transform_p_by_p_skipping_codeblocks(  # noqa: PLR0912, PLR0915
         if not _previous_line_was_empty:
             # at EOF
             process_current_paragraph()
-            current_paragraph = ''
-            for line_ in _maybe_icodeblock_lines:
-                current_paragraph += line_
+            current_paragraph_lines = []
+            current_paragraph_lines.extend(_maybe_icodeblock_lines)
             process_current_paragraph()
-            current_paragraph = ''
+            current_paragraph_lines = []
         else:
             process_current_paragraph()
-            current_paragraph = ''
+            current_paragraph_lines = []
             for line_ in _maybe_icodeblock_lines:
                 lines.append(line_)
     else:
@@ -547,8 +547,11 @@ def sort_paths(paths: list[str], order: OrderOption) -> list[str]:
                 return os.path.splitext(p)[1]
     elif order_type == 'natural':
         if order_by == 'extension':
-            def key(p: str) -> str:
-                return natural_sort_key(os.path.splitext(p)[1])  # type: ignore
+            def key(p: str) -> tuple:  # type: ignore
+                return (
+                    natural_sort_key(os.path.splitext(p)[1]),
+                    natural_sort_key(os.path.basename(p)),
+                )
         elif order_by == 'name':
             def key(p: str) -> str:
                 return natural_sort_key(os.path.basename(p))  # type: ignore