From b9e51b4c907a146a2c0ab62ae736925466e67e81 Mon Sep 17 00:00:00 2001
From: Markus Rullkoetter <markus.rullkoetter@dataport.de>
Date: Tue, 20 Aug 2024 10:23:21 +0200
Subject: [PATCH] add hint regarding heading slugification

---
 scripts/makeDocs.js | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/scripts/makeDocs.js b/scripts/makeDocs.js
index 4df2fcae3..e7b375996 100644
--- a/scripts/makeDocs.js
+++ b/scripts/makeDocs.js
@@ -15,6 +15,11 @@
  * docs and .md.)
  *
  * Call like `node ./scripts/makeDocs.js ./path/to/client`.
+ *
+ * Headings in markdowns will get a slugified ID by markdown-it-anchor to be linkable.
+ * It uses the default slugify function:
+ * (s) => encodeURIComponent(String(s).trim().toLowerCase().replace(/\s+/g, '-'))
+ *
  */
 
 // IMPORTS