@mgks/docmd 0.2.5 → 0.2.7

package/src/assets/js/docmd-main.js

@@ -36,6 +36,22 @@ function initializeCollapsibleNav() {
     toggleSubmenu(isExpanded);
 
     anchor.addEventListener('click', (e) => {
+      const currentExpanded = item.getAttribute('aria-expanded') === 'true';
+      const href = anchor.getAttribute('href');
+      const isPlaceholder = !href || href === '#' || href === '';
+
+      if (!currentExpanded) {
+        toggleSubmenu(true);
+      } else if (isPlaceholder || e.target.closest('.collapse-icon')) {
+        toggleSubmenu(false);
+      }
+
+      if (isPlaceholder || e.target.closest('.collapse-icon')) {
+        e.preventDefault();
+      }
+    });
+
+/*    anchor.addEventListener('click', (e) => {
       // If the click target is the icon, ALWAYS prevent navigation and toggle.
       if (e.target.closest('.collapse-icon')) {
         e.preventDefault();
@@ -47,7 +63,7 @@ function initializeCollapsibleNav() {
         toggleSubmenu(item.getAttribute('aria-expanded') !== 'true');
       }
       // Otherwise, let the click proceed to navigate to the link.
-    });
+    });*/
   });
 }
 

package/src/commands/build.js

@@ -6,6 +6,7 @@ const { loadConfig } = require('../core/config-loader');
 const { createMarkdownItInstance, processMarkdownFile, findMarkdownFiles } = require('../core/file-processor');
 const { generateHtmlPage, generateNavigationHtml } = require('../core/html-generator');
 const { renderIcon, clearWarnedIcons } = require('../core/icon-renderer');
+const { findPageNeighbors } = require('../core/navigation-helper');
 const { generateSitemap } = require('../plugins/sitemap');
 const { version } = require('../../package.json');
 const matter = require('gray-matter');
@@ -218,8 +219,12 @@ async function buildSite(configPath, options = { isDev: false, preserve: false,
 
       const finalOutputHtmlPath = path.join(OUTPUT_DIR, outputHtmlPath);
 
-      const depth = outputHtmlPath.split(path.sep).length - 1;
-      const relativePathToRoot = depth > 0 ? '../'.repeat(depth) : './';
+      let relativePathToRoot = path.relative(path.dirname(finalOutputHtmlPath), OUTPUT_DIR);
+      if (relativePathToRoot === '') {
+          relativePathToRoot = './';
+      } else {
+          relativePathToRoot = relativePathToRoot.replace(/\\/g, '/') + '/';
+      }
 
       let normalizedPath = path.relative(SRC_DIR, filePath).replace(/\\/g, '/');
       if (path.basename(normalizedPath) === 'index.md') {
@@ -247,74 +252,20 @@ async function buildSite(configPath, options = { isDev: false, preserve: false,
         config
       );
 
-      let prevPage = null;
-      let nextPage = null;
-      let currentPageIndex = -1;
-      
-      const flatNavigation = [];
-      
-      function createNormalizedPath(item) {
-        if (!item.path) return null;
-        return item.path.startsWith('/') ? item.path : '/' + item.path;
-      }
-      
-      function extractNavigationItems(items) {
-        if (!items || !Array.isArray(items)) return;
-        
-        for (const item of items) {
-          if (item.external) continue;
-          
-          if (item.path) {
-            let normalizedItemPath = createNormalizedPath(item);
-            if (item.children && !normalizedItemPath.endsWith('/')) {
-              normalizedItemPath += '/';
-            }
-            flatNavigation.push({
-              title: item.title,
-              path: normalizedItemPath,
-            });
-          }
-          
-          if (item.children && Array.isArray(item.children)) {
-            extractNavigationItems(item.children);
-          }
-        }
-      }
-      
-      extractNavigationItems(config.navigation);
-      
-      currentPageIndex = flatNavigation.findIndex(item => {
-        const itemPath = item.path;
-        const currentPagePath = normalizedPath;
-        if (itemPath === currentPagePath) {
-          return true;
-        }
-        if (itemPath.endsWith('/') && itemPath.slice(0, -1) === currentPagePath) {
-          return true;
-        }
-        if (currentPagePath.endsWith('/') && currentPagePath.slice(0, -1) === itemPath) {
-          return true;
-        }        
-        return false;
-      });
-      
-      if (currentPageIndex >= 0) {
-        if (currentPageIndex > 0) prevPage = flatNavigation[currentPageIndex - 1];
-        if (currentPageIndex < flatNavigation.length - 1) nextPage = flatNavigation[currentPageIndex + 1];
-      }
-      
+      // Find previous and next pages for navigation
+      const { prevPage, nextPage } = findPageNeighbors(config.navigation, normalizedPath);
+
       if (prevPage) {
-        const cleanPath = prevPage.path.startsWith('/') ? prevPage.path.substring(1) : prevPage.path;
-        prevPage.url = relativePathToRoot + (cleanPath.endsWith('/') ? cleanPath : cleanPath + '/');
-        if (prevPage.path === '/') prevPage.url = relativePathToRoot;
+        const cleanPath = prevPage.path.substring(1);
+        prevPage.url = relativePathToRoot + cleanPath;
       }
       
       if (nextPage) {
-        const cleanPath = nextPage.path.startsWith('/') ? nextPage.path.substring(1) : nextPage.path;
-        nextPage.url = relativePathToRoot + (cleanPath.endsWith('/') ? cleanPath : cleanPath + '/');
-        if (nextPage.path === '/') nextPage.url = relativePathToRoot;
+        const cleanPath = nextPage.path.substring(1);
+        nextPage.url = relativePathToRoot + cleanPath;
       }
 
+      // Log navigation paths for debugging
       const pageDataForTemplate = {
         content: htmlContent,
         pageTitle: pageFrontmatter.title || 'Untitled',

package/src/core/config-loader.js

@@ -2,19 +2,22 @@
 
 const path = require('path');
 const fs = require('fs-extra');
+const { validateConfig } = require('./config-validator');
 
 async function loadConfig(configPath) {
   const absoluteConfigPath = path.resolve(process.cwd(), configPath);
   if (!await fs.pathExists(absoluteConfigPath)) {
-    throw new Error(`Configuration file not found: ${absoluteConfigPath}`);
+    throw new Error(`Configuration file not found at: ${absoluteConfigPath}\nRun "docmd init" to create one.`);
   }
   try {
     // Clear require cache to always get the freshest config
     delete require.cache[require.resolve(absoluteConfigPath)];
     const config = require(absoluteConfigPath);
 
+    // Validate configuration call
+    validateConfig(config);
+
     // Basic validation and defaults
-    if (!config.siteTitle) throw new Error('`siteTitle` is missing in config file');
     config.srcDir = config.srcDir || 'docs';
     config.outputDir = config.outputDir || 'site';
     config.theme = config.theme || {};
@@ -24,7 +27,10 @@ async function loadConfig(configPath) {
 
     return config;
   } catch (e) {
-    throw new Error(`Error loading or parsing config file ${absoluteConfigPath}: ${e.message}`);
+    if (e.message === 'Invalid configuration file.') {
+      throw e;
+    }
+    throw new Error(`Error parsing config file: ${e.message}`);
   }
 }
 

package/src/core/config-validator.js

@@ -0,0 +1,79 @@
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+const chalk = require('chalk');
+
+// Known configuration keys for typo detection
+const KNOWN_KEYS = [
+  'siteTitle', 'siteUrl', 'srcDir', 'outputDir', 'logo', 
+  'sidebar', 'theme', 'customJs', 'autoTitleFromH1', 
+  'copyCode', 'plugins', 'navigation', 'footer', 'sponsor', 'favicon'
+];
+
+// Common typos mapping
+const TYPO_MAPPING = {
+  'site_title': 'siteTitle',
+  'sitetitle': 'siteTitle',
+  'baseUrl': 'siteUrl',
+  'source': 'srcDir',
+  'out': 'outputDir',
+  'customCSS': 'theme.customCss',
+  'customcss': 'theme.customCss',
+  'customJS': 'customJs',
+  'customjs': 'customJs',
+  'nav': 'navigation',
+  'menu': 'navigation'
+};
+
+function validateConfig(config) {
+  const errors = [];
+  const warnings = [];
+
+  // 1. Required Fields
+  if (!config.siteTitle) {
+    errors.push('Missing required property: "siteTitle"');
+  }
+
+  // 2. Type Checking
+  if (config.navigation && !Array.isArray(config.navigation)) {
+    errors.push('"navigation" must be an Array');
+  }
+
+  if (config.customJs && !Array.isArray(config.customJs)) {
+    errors.push('"customJs" must be an Array of strings');
+  }
+
+  if (config.theme) {
+    if (config.theme.customCss && !Array.isArray(config.theme.customCss)) {
+      errors.push('"theme.customCss" must be an Array of strings');
+    }
+  }
+
+  // 3. Typos and Unknown Keys (Top Level)
+  Object.keys(config).forEach(key => {
+    if (TYPO_MAPPING[key]) {
+      warnings.push(`Found unknown property "${key}". Did you mean "${TYPO_MAPPING[key]}"?`);
+    }
+  });
+
+  // 4. Theme specific typos
+  if (config.theme) {
+    if (config.theme.customCSS) {
+      warnings.push('Found "theme.customCSS". Did you mean "theme.customCss"?');
+    }
+  }
+
+  // Output results
+  if (warnings.length > 0) {
+    console.log(chalk.yellow('\n⚠️  Configuration Warnings:'));
+    warnings.forEach(w => console.log(chalk.yellow(`   - ${w}`)));
+  }
+
+  if (errors.length > 0) {
+    console.log(chalk.red('\n❌ Configuration Errors:'));
+    errors.forEach(e => console.log(chalk.red(`   - ${e}`)));
+    console.log('');
+    throw new Error('Invalid configuration file.');
+  }
+}
+
+module.exports = { validateConfig };

package/src/core/file-processor.js

@@ -88,7 +88,15 @@ function createMarkdownItInstance(config) {
   md.renderer.rules.ordered_list_open = customOrderedListOpenRenderer;
   md.renderer.rules.list_item_open = customListItemOpenRenderer;
   md.renderer.rules.image = customImageRenderer;
-  
+
+  // Wrap tables in a container for horizontal scrolling
+  md.renderer.rules.table_open = function(tokens, idx, options, env, self) {
+    return '<div class="table-wrapper">' + self.renderToken(tokens, idx, options);
+  };
+  md.renderer.rules.table_close = function(tokens, idx, options, env, self) {
+    return self.renderToken(tokens, idx, options) + '</div>';
+  };
+
   // Register tabs renderers
   md.renderer.rules.tabs_open = tabsOpenRenderer;
   md.renderer.rules.tabs_nav_open = tabsNavOpenRenderer;

package/src/core/html-generator.js

@@ -1,4 +1,4 @@
-//
+// Source file from the docmd project — https://github.com/mgks/docmd
 
 const ejs = require('ejs');
 const path = require('path');

package/src/core/logger.js

@@ -0,0 +1,21 @@
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+const chalk = require('chalk');
+
+const { version } = require('../../package.json');
+
+const printBanner = () => {
+  const logo = `
+                       
+${chalk.blue('     _                 _ ')}
+${chalk.blue('   _| |___ ___ _____ _| |')}
+${chalk.blue('  | . | . |  _|     | . |')}
+${chalk.blue('  |___|___|___|_|_|_|___|')}
+  `;
+
+  console.log(logo);
+  console.log(`   ${chalk.dim(`v${version}`)}`);
+  console.log(`\n`);
+};
+
+module.exports = { printBanner };

package/src/core/navigation-helper.js

@@ -0,0 +1,62 @@
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+/**
+ * Flattens the navigation tree and finds the previous and next pages relative to the current page.
+ * @param {Array} navItems - The navigation array from config.
+ * @param {string} currentPagePath - The normalized path of the current page.
+ * @returns {{prevPage: object|null, nextPage: object|null}}
+ */
+function findPageNeighbors(navItems, currentPagePath) {
+  const flatNavigation = [];
+
+  // Recursive function to flatten the navigation tree
+  function extractNavigationItems(items) {
+    if (!items || !Array.isArray(items)) return;
+    
+    for (const item of items) {
+      if (item.external || !item.path || item.path === '#') {
+        // If it's a category with no path but has children, recurse into them
+        if (item.children && Array.isArray(item.children)) {
+          extractNavigationItems(item.children);
+        }
+        continue; // Skip external links and parent items without a direct path
+      }
+
+      let normalizedItemPath = item.path;
+
+      // Ensure it starts with a slash
+      if (!normalizedItemPath.startsWith('/')) {
+        normalizedItemPath = '/' + normalizedItemPath;
+      }
+
+      // Ensure it ends with a slash (unless it's the root path)
+      if (normalizedItemPath.length > 1 && !normalizedItemPath.endsWith('/')) {
+        normalizedItemPath += '/';
+      }
+
+      flatNavigation.push({
+        title: item.title,
+        path: normalizedItemPath,
+      });
+
+      if (item.children && Array.isArray(item.children)) {
+        extractNavigationItems(item.children);
+      }
+    }
+  }
+
+  extractNavigationItems(navItems);
+
+  const currentPageIndex = flatNavigation.findIndex(item => item.path === currentPagePath);
+
+  if (currentPageIndex === -1) {
+    return { prevPage: null, nextPage: null };
+  }
+
+  const prevPage = currentPageIndex > 0 ? flatNavigation[currentPageIndex - 1] : null;
+  const nextPage = currentPageIndex < flatNavigation.length - 1 ? flatNavigation[currentPageIndex + 1] : null;
+
+  return { prevPage, nextPage };
+}
+
+module.exports = { findPageNeighbors };