Merge pull request #58 from UmbrellaDocs/section-links-fix

Use GitHub slugger for converting ID to slug

lib/check-file-links.js

@@ -4,6 +4,7 @@ import { unified } from "unified";
 import remarkParse from "remark-parse";
 import remarkGfm from "remark-gfm";
 import { visit } from "unist-util-visit";
+import GithubSlugger from 'github-slugger'
 
 /**
  * Checks if a file and a section within the file exist.
@@ -19,6 +20,7 @@ function checkFileExistence(link, file) {
   let errorMessage = "";
 
   try {
+    let slugger = new GithubSlugger()
     // Split the URL into the file part and the section part
     const [urlWithoutSection = "", sectionId = null] = link.url.split("#");
 
@@ -40,14 +42,14 @@ function checkFileExistence(link, file) {
       const tree = unified().use(remarkParse).use(remarkGfm).parse(mdContent);
 
       // Collect all heading IDs in the file
+      // Use GitHub slugger to generate the heading slug for comparison
       const headingNodes = new Set();
       visit(tree, "heading", (node) => {
         const headingId = node.children[0].type === "html"
           ? node.children[0].value.match(/name="(.+?)"/)?.[1]
           : node.children[0].value.includes("{#")
           ? node.children[0].value.match(/{#(.+?)}/)?.[1]
-          : node.children[0].value.toLowerCase().replace(/ /g, "-").replace(/\./g, "");
-
+          : slugger.slug(node.children[0].value);
         headingNodes.add(headingId);
       });
 

package.json

@@ -25,6 +25,7 @@
   "homepage": "https://github.com/UmbrellaDocs/linkspector#readme",
   "dependencies": {
     "commander": "^12.0.0",
+    "github-slugger": "^2.0.0",
     "glob": "^10.3.12",
     "ignore": "^5.3.1",
     "joi": "^17.13.1",