@mgks/docmd 0.2.4 → 0.2.6

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/commands/dev.js

@@ -28,7 +28,7 @@ function formatPathForDisplay(absolutePath, cwd) {
   return relativePath;
 }
 
-async function startDevServer(configPathOption, options = { preserve: false }) {
+async function startDevServer(configPathOption, options = { preserve: false, port: undefined }) {
   let config = await loadConfig(configPathOption); // Load initial config
   const CWD = process.cwd(); // Current Working Directory where user runs `docmd dev`
 
@@ -264,9 +264,9 @@ async function startDevServer(configPathOption, options = { preserve: false }) {
   watcher.on('error', error => console.error(`Watcher error: ${error}`));
 
   // Try different ports if the default port is in use
-  const PORT = process.env.PORT || 3000;
+  const PORT = options.port || process.env.PORT || 3000;
   const MAX_PORT_ATTEMPTS = 10;
-  let currentPort = PORT;
+  let currentPort = parseInt(PORT, 10);
   
   // Function to try starting the server on different ports
   function tryStartServer(port, attempt = 1) {

package/src/commands/init.js

@@ -4,7 +4,7 @@ const fs = require('fs-extra');
 const path = require('path');
 const readline = require('readline');
 
-const defaultConfigContent = `// config.js: basic config for docmd
+const defaultConfigContent = `// docmd.config.js: basic config for docmd
 module.exports = {
   // Core Site Metadata
   siteTitle: 'docmd',
@@ -108,6 +108,8 @@ module.exports = {
       { title: 'GitHub', path: 'https://github.com/mgks/docmd', icon: 'github', external: true },
       { title: 'Support the Project', path: 'https://github.com/sponsors/mgks', icon: 'heart', external: true },
     ],
+    
+  pageNavigation: true, // Enable previous / next page navigation at the bottom of each page
 
   // Sponsor Ribbon Configuration
   Sponsor: {
@@ -139,7 +141,7 @@ Start writing your Markdown content here.
 async function initProject() {
   const baseDir = process.cwd();
   const docsDir = path.join(baseDir, 'docs');
-  const configFile = path.join(baseDir, 'config.js');
+  const configFile = path.join(baseDir, 'docmd.config.js');
   const indexMdFile = path.join(docsDir, 'index.md');
   const assetsDir = path.join(baseDir, 'assets');
   const assetsCssDir = path.join(assetsDir, 'css');
@@ -154,6 +156,11 @@ async function initProject() {
   
   // Check each file individually
   if (await fs.pathExists(configFile)) {
+    existingFiles.push('docmd.config.js');
+  }
+  // Check for the config.js as well to warn the user
+  const oldConfigFile = path.join(baseDir, 'config.js');
+  if (await fs.pathExists(oldConfigFile)) {
     existingFiles.push('config.js');
   }
   
@@ -230,14 +237,11 @@ async function initProject() {
   }
   
   // Write config file if it doesn't exist or user confirmed override
-  if (!await fs.pathExists(configFile)) {
-    await fs.writeFile(configFile, defaultConfigContent, 'utf8');
-    console.log('📄 Created `config.js`');
-  } else if (shouldOverride) {
+  if (!await fs.pathExists(configFile) || shouldOverride) {
     await fs.writeFile(configFile, defaultConfigContent, 'utf8');
-    console.log('📄 Updated `config.js`');
+    console.log(`📄 ${shouldOverride ? 'Updated' : 'Created'} \`docmd.config.js\``);
   } else {
-    console.log('⏭️  Skipped existing `config.js`');
+    console.log('⏭️  Skipped existing `docmd.config.js`');
   }
   
   // Write index.md file if it doesn't exist or user confirmed override

package/src/core/config-loader.js

@@ -14,12 +14,13 @@ async function loadConfig(configPath) {
     const config = require(absoluteConfigPath);
 
     // Basic validation and defaults
-    if (!config.siteTitle) throw new Error('`siteTitle` is missing in config.js');
+    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 || {};
     config.theme.defaultMode = config.theme.defaultMode || 'light';
     config.navigation = config.navigation || [{ title: 'Home', path: '/' }];
+    config.pageNavigation = config.pageNavigation ?? true;
 
     return config;
   } catch (e) {

package/src/core/file-processor.js

@@ -34,6 +34,11 @@ function createMarkdownItInstance(config) {
   // Conditionally enable highlighting
   if (config.theme?.codeHighlight !== false) {
     mdOptions.highlight = function (str, lang) {
+      // Handle mermaid diagrams
+      if (lang === 'mermaid') {
+        return `<pre class="mermaid">${new MarkdownIt().utils.escapeHtml(str)}</pre>`;
+      }
+      
       if (lang && hljs.getLanguage(lang)) {
         try {
           return `<pre class="hljs"><code>${hljs.highlight(str, { language: lang, ignoreIllegals: true }).value}</code></pre>`;
@@ -41,6 +46,14 @@ function createMarkdownItInstance(config) {
       }
       return `<pre class="hljs"><code>${new MarkdownIt().utils.escapeHtml(str)}</code></pre>`;
     };
+  } else {
+    // Even if highlighting is disabled, we need to handle mermaid
+    mdOptions.highlight = function (str, lang) {
+      if (lang === 'mermaid') {
+        return `<pre class="mermaid">${new MarkdownIt().utils.escapeHtml(str)}</pre>`;
+      }
+      return `<pre><code>${new MarkdownIt().utils.escapeHtml(str)}</code></pre>`;
+    };
   }
 
   const md = new MarkdownIt(mdOptions);
@@ -464,6 +477,11 @@ function enhancedTabsRule(state, startLine, endLine, silent) {
         typographer: true,
         breaks: true,
         highlight: function (str, lang) {
+          // Handle mermaid diagrams in tabs
+          if (lang === 'mermaid') {
+            return '<pre class="mermaid">' + MarkdownIt.utils.escapeHtml(str) + '</pre>';
+          }
+          
           if (lang && hljs.getLanguage(lang)) {
             try {
               return '<pre class="hljs"><code>' +

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');
@@ -124,7 +124,7 @@ async function generateHtmlPage(templateData) {
         prevPage,
         nextPage,
         currentPagePath,
-        headings: headings || [],
+        headings: frontmatter.toc !== false ? (headings || []) : [],
         isActivePage,
         frontmatter,
         config: config,

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 };

package/src/templates/layout.ejs

@@ -79,7 +79,7 @@
                 <div class="main-content">
                     <%- content %>
                     
-                    <% if (prevPage || nextPage) { %>
+                    <% if (config.pageNavigation && (prevPage || nextPage)) { %>
                     <div class="page-navigation">
                         <% if (prevPage) { %>
                         <a href="<%= prevPage.url %>" class="prev-page">
@@ -129,6 +129,10 @@
     </div>
 
     <script src="<%= relativePathToRoot %>assets/js/docmd-main.js"></script>
+    
+    <!-- Mermaid.js for diagram rendering -->
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.min.js"></script>
+    <script src="<%= relativePathToRoot %>assets/js/docmd-mermaid.js"></script>
 
     <% (customJsFiles || []).forEach(jsFile => { %>
       <script src="<%= relativePathToRoot %><%- jsFile.startsWith('/') ? jsFile.substring(1) : jsFile %>"></script>

package/src/templates/toc.ejs

@@ -15,7 +15,7 @@ function decodeHtmlEntities(html) {
 const shouldShowToc = typeof isActivePage !== 'undefined' ? isActivePage : 
                       (typeof navigationHtml !== 'undefined' && navigationHtml && navigationHtml.includes('class="active"'));
 
-if (shouldShowToc) {
+if (shouldShowToc && !frontmatter?.toc || frontmatter?.toc !== 'false') {
   // If direct headings aren't available, we'll try to extract them from the content
   let tocHeadings = [];
   if (headings && headings.length > 0) {