Rename from max_level to link_depth

Author: rundef

docs/extensions/toc.md

@@ -252,11 +252,11 @@ The following options are provided to configure the output:
     included in the Table of Contents. To exclude this first level, you
     have to set `toc_depth` to `"4-6"`.
 
-* **`max_level`**
-    Define the highest heading level (deepest `<hN>`) for which to add anchor links or permalinks.
+* **`link_depth`**
+    Add anchors/permalinks only to headings up to this depth (`h1`–`hN`).
     Defaults to `6`.
 
-    For example, setting max_level to `2` adds anchors only to `<h1>` and `<h2>` elements.
+    For example, setting `link_depth` to `2` adds anchors only to `<h1>` and `<h2>` elements.
 
 A trivial example:
 

markdown/extensions/toc.py

@@ -257,7 +257,7 @@ def __init__(self, md: Markdown, config: dict[str, Any]):
         self.permalink_class: str = config["permalink_class"]
         self.permalink_title: str = config["permalink_title"]
         self.permalink_leading: bool | None = parseBoolValue(config["permalink_leading"], False)
-        self.header_rgx = re.compile(f'[Hh][1-{config["max_level"]}]')
+        self.header_rgx = re.compile(f'[Hh][1-{config["link_depth"]}]')
         if isinstance(config["toc_depth"], str) and '-' in config["toc_depth"]:
             self.toc_top, self.toc_bottom = [int(x) for x in config["toc_depth"].split('-')]
         else:
@@ -466,9 +466,10 @@ def __init__(self, **kwargs):
                 'separated by a hyphen in between (`2-5`) defines the top (t) and the bottom (b) (<ht>..<hb>). '
                 'Default: `6` (bottom).'
             ],
-            'max_level': [
+            'link_depth': [
                 6,
-                'Define the max heading level for which to add anchors/permalinks.'
+                'Add anchors/permalinks only to headings up to this depth (`h1`–`hN`). '
+                'For example, `link_depth: 2` adds them to `h1` and `h2` only. '
                 'Default: `6`'
             ]
         }

tests/test_syntax/extensions/test_toc.py

@@ -555,7 +555,7 @@ def testAnchorLinkWithDoubleInlineCode(self):
             extensions=[TocExtension(anchorlink=True)]
         )
 
-    def testAnchorLinkWithMaxLevel(self):
+    def testAnchorLinkWithLinkDepth(self):
         self.assertMarkdownRenders(
             self.dedent(
                 '''
@@ -570,7 +570,7 @@ def testAnchorLinkWithMaxLevel(self):
                 <h2>Header <em>2</em></h2>
                 '''
             ),
-            extensions=[TocExtension(anchorlink=True, max_level=1)]
+            extensions=[TocExtension(anchorlink=True, link_depth=1)]
         )
 
     def testPermalink(self):