Fix internal linking v1

Author: Gianluca Beil

internal/documentation/jsdoc-to-markdown.js

@@ -54,6 +54,7 @@ async function htmlToMarkdown(options = {}) {
             document: false,
             handlers: {
                 table(state, node) {
+                    // This fixes nested tables that happen in the conversion from html to markdown
                     let html = toHtml(node);
                     const parsedHTML = new JSDOM(html).window.document.getElementsByClassName("params")[1];
                     if (parsedHTML !== undefined) {
@@ -62,6 +63,19 @@ async function htmlToMarkdown(options = {}) {
                     const result = {type: "html", value: html};
                     state.patch(node, result);
                     return result;
+                },
+                a(state, node) {
+                    // This fixes internal linking e.g. from #~myawesomemethod to #myawesomemethod
+                    const regex = /<a.*?href="(.*?)".*?>([^<]*)<\/a>/;
+                    const result = {type: "html", value: toHtml(node).replaceAll("~", "")};
+                    let href = result.value.match(regex);
+                    if (href !== null && href[1].split("#")[1] != null) {
+                        let text = href[2];
+                        href = href[1];
+                        result.value = result.value.replace(href, "#" + href.split("#")[1].toLowerCase()).replace(text, text.replace(href.split("#")[1], "") + "#" + href.split("#")[1]);
+                    }
+                    state.patch(node, result);
+                    return result;
                 }
             }
         })
@@ -96,13 +110,19 @@ if (!fs.existsSync(outputDirectory)) {
 
 // 3. Iterate through every .html generated by jsdoc
 for (const file of fs.readdirSync(path.join("dist", "api"))) {
-    // Skip js files
+    // Skip some files
 	if (excludedFiles[file] !== undefined) continue;
 
+    // Skip js files
+    if (file.endsWith(".js.html")) continue;
+
     const filePath = path.join(inputDirectory, file);
+    const mardownPath = path.join(outputDirectory, file.replace(".html", ".md"));
     // Skip directories
 	if (fs.statSync(filePath).isDirectory()) continue;
 
+    //console.log("HTML -> Markdown", "|", filePath, "->", mardownPath);
+
     // Read the html file
 	const htmlString = fs.readFileSync(filePath);
 
@@ -126,7 +146,9 @@ for (const file of fs.readdirSync(path.join("dist", "api"))) {
 
     // Save markdown file
     fs.writeFileSync(
-        path.join(outputDirectory, file.replace(".html", ".md")),
+        mardownPath,
         markdown
     );
 }
+
+console.log("Conversion done");