docs: add docs for patch

konyakest · Feb 17, 2023 · 4987d77 · 4987d77
1 parent f759e2c
commit 4987d77
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/patches/README.md b/patches/README.md
@@ -0,0 +1,7 @@
+# Patches
+
+为了保证与 mkdocs 的兼容性，我们 patch 了 `mdast-util-to-markdown`。具体变化如下
+
+- 使用 2 space style 的 hardbreak
+- 避免 escape `&`
+- 避免将等号视为 heading