Fix some link names in docs has .md extension

debridge-finance · Dec 2, 2021 · e9e655d · e9e655d
1 parent c14ff11
commit e9e655d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/docs/generateTableOfContents/parts/generateReadmesForDirsRecursively.ts b/docs/generateTableOfContents/parts/generateReadmesForDirsRecursively.ts
@@ -5,6 +5,7 @@ import {FileEntry, ListOfFiles} from "./types/ListOfFiles";
 import {README_NAME} from "./constants";
 import {isDir, isFile, notReadme} from "./filters";
 import {toLink} from "./toLink";
+import removeMdExtensionFromFileName from "./removeMdExtensionFromFileName";
 
 // start with h2
 const TOP_LEVEL = 2;
@@ -56,6 +57,7 @@ function convertListOfFilesToMarkdown(
 
     const filesAsMarkdown = fileEntries
         .map(makePathRelative)
+        .map(removeMdExtensionFromFileName)
         .map(([fileName, filePath]) => toLink(fileName, filePath))
         .join('\n')
     ;

diff --git a/docs/generateTableOfContents/parts/generateSidebarToc.ts b/docs/generateTableOfContents/parts/generateSidebarToc.ts
@@ -3,6 +3,7 @@ import {DirEntry, ListOfFiles} from "./types/ListOfFiles";
 import {isDir, isFile, notReadme} from "./filters";
 import {toLink} from "./toLink";
 import {CONTRACTS_PATH_IN_DOCS, README_NAME} from "./constants";
+import removeMdExtensionFromFileName from "./removeMdExtensionFromFileName";
 
 export default function generateSidebarToc(listOfFiles: ListOfFiles): string {
     const title = `## Contracts\n`;
@@ -36,6 +37,7 @@ function generateDirLinksWithSubLinks(
 
     const indent = (str: string): string => '  '.repeat(level) + str;
     const subLinks = fileEntries
+        .map(removeMdExtensionFromFileName)
         .map(([fileName, filePath]) => toLink(fileName, CONTRACTS_PATH_IN_DOCS + filePath))
         .map(indent)
         .join('\n');

diff --git a/docs/generateTableOfContents/parts/removeMdExtensionFromFileName.ts b/docs/generateTableOfContents/parts/removeMdExtensionFromFileName.ts
@@ -0,0 +1,6 @@
+import {FileEntry} from "./types/ListOfFiles";
+
+export default ([fileName, filePath]: FileEntry) => [
+    fileName.replace(/.md$/, ''),
+    filePath,
+];