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