docs: refactor and style update

Author: lokesh-coder

docs/builders/create-doc-nodes.js

@@ -0,0 +1,48 @@
+const pageConfig = require("../config/doc-pages-config");
+
+function createDocNodes({ node, getNode, actions: { createNodeField } }) {
+  if (node.internal.type !== `Mdx`) return;
+
+  const parentNode = getNode(node.parent);
+  const { relativePath, relativeDirectory, ext } = parentNode;
+
+  let value = relativePath.replace(ext, "");
+  value = value === "index" ? "" : value;
+  let screenName = relativePath.split("/")[0];
+  let sectionName = "";
+  if (relativeDirectory.split("/").length == 2) {
+    sectionName = pageConfig.pageSectionNames[relativeDirectory.split("/")[1]];
+  }
+
+  createNodeField({
+    name: `section`,
+    node,
+    value: sectionName,
+  });
+
+  createNodeField({
+    name: `screen`,
+    node,
+    value: screenName,
+  });
+
+  createNodeField({
+    name: `slug`,
+    node,
+    value: `/${value}`,
+  });
+
+  createNodeField({
+    name: "id",
+    node,
+    value: node.id,
+  });
+
+  createNodeField({
+    name: "title",
+    node,
+    value: node.frontmatter.title || startCase(parent.name),
+  });
+}
+
+exports.createDocNodes = createDocNodes;

docs/construct-pages/base.js renamed to docs/builders/create-doc-page.js

@@ -1,10 +1,10 @@
-const menuLinks = require("../config/page-order");
+const menuLinks = require("../config/doc-pages-config");
 const path = require("path");
 
-const createDocPage = async (createPage, graphql, reporter, screenName) => {
+async function createDocPage(createPage, graphql, reporter, screenName) {
   const result = await graphql(`
     query {
-      allMdx(filter: {fileAbsolutePath: {glob: "**/screen:${screenName}/**"}}) {
+      allMdx(filter: {fileAbsolutePath: {glob: "**/docs/${screenName}/**"}}) {
         edges {
           node {
             toc: tableOfContents(maxDepth: 4)
@@ -42,8 +42,10 @@ const createDocPage = async (createPage, graphql, reporter, screenName) => {
   menuLinks[`${screenName}ScreenMenuLinks`].forEach(
     (page, index) => (pageOrderMap[page] = index),
   );
+
   pages.forEach((page) => {
     if (pageOrderMap[page.node.parent.fileName] !== false) {
+      console.log("**", pageOrderMap, page.node.parent.fileName);
       finalPageEdges[pageOrderMap[page.node.parent.fileName]] = page;
     }
   });
@@ -52,7 +54,6 @@ const createDocPage = async (createPage, graphql, reporter, screenName) => {
     const context = {
       id: node.fields.id,
       ind: index,
-      abc: "foo",
       prev: index === 0 ? null : finalPageEdges[index - 1].node,
       next:
         index === finalPageEdges.length - 1
@@ -65,11 +66,11 @@ const createDocPage = async (createPage, graphql, reporter, screenName) => {
     }
     createPage({
       path: node.frontmatter.path,
-      component: path.resolve(`./src/templates/docs.js`),
+      component: path.resolve(`./templates/docs-template.js`),
       context,
     });
   });
-};
+}
 
 module.exports = {
   createDocPage,

docs/builders/create-doc-pages.js

@@ -0,0 +1,21 @@
+const { createDocPage } = require("./create-doc-page");
+
+function createDocPages(pageTools) {
+  const { graphql, actions, reporter } = pageTools;
+  const { createPage, createRedirect } = actions;
+
+  createRedirect({
+    fromPath: `/docs/core/even-more`,
+    isPermanent: true,
+    redirectInBrowser: true,
+    toPath: `/docs/dev/performance`,
+  });
+
+  const allDocs = [];
+  ["main", "dev", "plugins"].forEach((name) => {
+    allDocs.push(createDocPage(createPage, graphql, reporter, name));
+  });
+  return Promise.all(allDocs);
+}
+
+exports.createDocPages = createDocPages;

docs/builders/index.js

@@ -0,0 +1,7 @@
+const { createDocNodes } = require("./create-doc-nodes");
+const { createDocPages } = require("./create-doc-pages");
+
+module.exports = {
+  createDocNodes,
+  createDocPages,
+};

docs/config/doc-pages-config.js

@@ -0,0 +1,49 @@
+const pageSectionNames = {
+  "get-started": "Get started",
+  core: "Core",
+  library: "Library",
+  develop: "Develop",
+  recipies: "Recipies",
+  docs: "Plugins",
+};
+
+const mainScreenMenuLinks = [
+  "main/get-started/overview.md",
+  "main/get-started/installation.md",
+  "main/get-started/concepts.md",
+  "main/core/commands.md",
+  "main/core/middlewares.md",
+  "main/core/features.md",
+  "main/core/plugins.md",
+  "main/core/config.md",
+  "main/core/testing.md",
+  "main/core/even-more.md",
+  "main/library/official-plugins.md",
+  "main/library/helpers.md",
+  "main/develop/api.md",
+  "main/develop/release-notes.md",
+  "main/develop/roadmap.md",
+  "main/develop/credits.md",
+];
+
+const devScreenMenuLinks = [
+  "dev/recipies/performance.md",
+  "dev/recipies/sample2.md",
+];
+
+const pluginsScreenMenuLinks = [
+  "plugins/docs/generator.md",
+  "plugins/docs/configfiles.md",
+  "plugins/docs/configstore.md",
+  "plugins/docs/help.md",
+  "plugins/docs/pilot.md",
+  "plugins/docs/prompt.md",
+  "plugins/docs/validator.md",
+];
+
+module.exports = {
+  mainScreenMenuLinks,
+  devScreenMenuLinks,
+  pageSectionNames,
+  pluginsScreenMenuLinks,
+};