add hint regarding heading slugification

Dataport · Aug 20, 2024 · b9e51b4 · b9e51b4
1 parent d663e91
commit b9e51b4
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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