Apexdocs improvements (#158)

Author: cesarParra

.idea/git_toolbox_blame.xml

@@ -1,41 +1,55 @@
 import {readFileSync, writeFileSync} from "fs";
-import {OutputDir, TargetFile} from "@cparra/apexdocs/lib/settings";
+import {defineMarkdownConfig, skip} from "@cparra/apexdocs";
 
-function onBeforeFileWrite(file: TargetFile): TargetFile {
-    const outputDir: OutputDir = {
-        baseDir: file.dir.baseDir,
-        fileDir: file.name
-    };
+export default defineMarkdownConfig({
+    sourceDir: 'expression-src',
+    targetDir: 'docs/src/app/docs/api',
+    scope: ['global'],
+    namespace: 'expression',
+    documentationRootDir: '/docs/api',
+    transformReference: (reference) => {
+        return {
+            outputDocPath: reference.outputDocPath.replace('.md', '/page.md'),
+            referencePath: reference.referencePath.replace('.md', ''),
+        };
+    },
+    transformReferenceGuide: () => {
+        return skip();
+    },
+    transformDocPage: (docPage) => {
+        return {
+            frontmatter: {
+                nextjs: {
+                    metadata: {
+                        title: docPage.source.name,
+                        description: `Api documentation for the ${docPage.source.name} ${docPage.source.type}}`,
+                    }
+                }
+            },
+        };
+    },
+    transformDocs: (docs) => {
+        const navFileContents = readFileSync("docs/src/lib/navigation.json", "utf8");
+        const navItems = JSON.parse(navFileContents);
+        // Find an object whose title is "Api"
+        let apiNavObject = navItems.find((navObject: any) => navObject.title === "Api");
+        apiNavObject = apiNavObject ?? {title: "Api", links: []};
 
-    return {
-        name: 'page',
-        extension: '.md',
-        dir: outputDir
-    }
-}
+        apiNavObject.links = docs.map((doc) => {
+            return {
+                title: doc.source.name, href: `/docs/api/${doc.outputDocPath.replace('page.md', '').replace(/\/$/, '')}`
+            };
+        });
 
-function onAfterProcess(files: TargetFile[]) {
-    const navFileContents = readFileSync("docs/src/lib/navigation.json", "utf8");
-    const navItems = JSON.parse(navFileContents);
-    // Find an object whose title is "Api"
-    let apiNavObject = navItems.find((navObject: any) => navObject.title === "Api");
-    apiNavObject = apiNavObject ?? {title: "Api", links: []};
+        // replace the Api object with the new one (or add it if it didn't exist)
+        const newNavItems = navItems.filter((navObject: any) => navObject.title !== "Api");
+        newNavItems.push(apiNavObject);
 
-    apiNavObject.links = files.filter((file) => file.dir.fileDir !== 'index').map((file) => {
-        return {title: file.dir.fileDir, href: `/docs/api/${file.dir.fileDir}`};
-    });
+        // Write the new navigation.json file
+        const newNavFileContents = JSON.stringify(newNavItems, null, 2);
+        console.log("Writing new navigation.json file");
+        writeFileSync("docs/src/lib/navigation.json", newNavFileContents);
 
-    // replace the Api object with the new one (or add it if it didn't exist)
-    const newNavItems = navItems.filter((navObject: any) => navObject.title !== "Api");
-    newNavItems.push(apiNavObject);
-
-    // Write the new navigation.json file
-    const newNavFileContents = JSON.stringify(newNavItems, null, 2);
-    console.log("Writing new navigation.json file");
-    writeFileSync("docs/src/lib/navigation.json", newNavFileContents);
-}
-
-export default {
-    onBeforeFileWrite,
-    onAfterProcess
-};
+        return docs;
+    },
+});