Fix special characters causing weird escape sequences

mkdocs_literate_nav/parser.py

@@ -8,6 +8,7 @@
 
 import markdown
 import markdown.extensions
+import markdown.postprocessors
 import markdown.preprocessors
 import markdown.treeprocessors
 import mkdocs.utils
@@ -17,6 +18,8 @@
 log = logging.getLogger(f"mkdocs.plugins.{__name__}")
 log.addFilter(mkdocs.utils.warning_filter)
 
+_unescape = markdown.postprocessors.UnescapePostprocessor().run
+
 
 NavItem = Dict[Optional[str], Union[str, Any]]
 Nav = List[NavItem]
@@ -69,6 +72,8 @@ def nav(self) -> Optional[etree.Element]:
             return None
 
     def extendMarkdown(self, md):
+        md.inlinePatterns.deregister("html", strict=False)
+        md.inlinePatterns.deregister("entity", strict=False)
         md.preprocessors.register(_Preprocessor(md), _NAME, 25)
         self._treeprocessor = _Treeprocessor(md)
         md.treeprocessors.register(self._treeprocessor, _NAME, 19)
@@ -149,7 +154,7 @@ def make_nav(
                         out_item = get_nav_for_roots((abs_link, *roots))
                     except RecursionError as e:
                         log.warning(f"{e} ({link!r})")
-                out_title = "".join(child.itertext())
+                out_title = _unescape("".join(child.itertext()))
                 child = next(children)
             if child.tag in _LIST_TAGS:
                 out_item = make_nav(child, get_nav_for_roots, globber, roots, seen_items, out_item)

tests/markdown_to_nav/test_fancy_link.yml

@@ -4,7 +4,7 @@ navs:
         * [Item **1**](item1.md)
         * [Item 2](item2.md)
     2. Section 2
-        * [Item](section2/item.md)
+        * [`Item`](section2/item.md)
 output:
 - Section 1:
   - Item 1: item1.md

tests/markdown_to_nav/test_special_chars.yml

@@ -0,0 +1,13 @@
+navs:
+  /: |
+    * [a&b](a.md)
+    * [a&b](b.md)
+    * [a&b](c.md)
+    * [\__init__](d.md)
+    * [\`hi`](e.md)
+output:
+- a&b: a.md
+- a&b: b.md
+- a&b: c.md
+- __init__: d.md
+- '`hi`': e.md