@mgks/docmd 0.2.0 → 0.2.2

package/src/core/file-processor.js

@@ -1,9 +1,9 @@
-// src/core/file-processor.js
+// Source file from the docmd project — https://github.com/mgks/docmd
+
 const fs = require('fs-extra');
 const MarkdownIt = require('markdown-it');
 const matter = require('gray-matter');
 const hljs = require('highlight.js');
-const container = require('markdown-it-container');
 const attrs = require('markdown-it-attrs');
 const path = require('path');
 const markdown_it_footnote = require('markdown-it-footnote');
@@ -23,59 +23,80 @@ function formatPathForDisplay(absolutePath) {
   return relativePath;
 }
 
-// Initialize MarkdownIt with plugins and options.
-const md = new MarkdownIt({
-  html: true,
-  linkify: true,
-  typographer: true,
-  breaks: true,
-  highlight: function (str, lang) {
-    if (lang && hljs.getLanguage(lang)) {
-      try {
-        return '<pre class="hljs"><code>' +
-               hljs.highlight(str, { language: lang, ignoreIllegals: true }).value +
-               '</code></pre>';
-      } catch (e) { console.error(`Error highlighting language ${lang}:`, e); }
-    }
-    // For non-language code blocks, preserve the original content without processing
-    return '<pre class="hljs"><code>' + str + '</code></pre>';
+function createMarkdownItInstance(config) {
+  const mdOptions = {
+    html: true,
+    linkify: true,
+    typographer: true,
+    breaks: true,
+  };
+   
+  // Conditionally enable highlighting
+  if (config.theme?.codeHighlight !== false) {
+    mdOptions.highlight = function (str, lang) {
+      if (lang && hljs.getLanguage(lang)) {
+        try {
+          return `<pre class="hljs"><code>${hljs.highlight(str, { language: lang, ignoreIllegals: true }).value}</code></pre>`;
+        } catch (e) { console.error(`Highlighting error for lang ${lang}:`, e); }
+      }
+      return `<pre class="hljs"><code>${new MarkdownIt().utils.escapeHtml(str)}</code></pre>`;
+    };
   }
-});
-
 
+  const md = new MarkdownIt(mdOptions);
+
+  // --- Attach all plugins and rules to this instance ---
+  md.use(attrs, { leftDelimiter: '{', rightDelimiter: '}' });
+  md.use(markdown_it_footnote);
+  md.use(markdown_it_task_lists);
+  md.use(markdown_it_abbr);
+  md.use(markdown_it_deflist);
+  md.use(headingIdPlugin);
+
+  // Register renderers for all containers
+  Object.keys(containers).forEach(containerName => {
+    const container = containers[containerName];
+    md.renderer.rules[`container_${containerName}_open`] = container.render;
+    md.renderer.rules[`container_${containerName}_close`] = container.render;
+  });
 
-// Use standard markdown-it plugins for extended syntax support.
-md.use(attrs, { leftDelimiter: '{', rightDelimiter: '}' });
-md.use(markdown_it_footnote);
-md.use(markdown_it_task_lists);
-md.use(markdown_it_abbr);
-md.use(markdown_it_deflist);
-
-// Override the default fence renderer to preserve original content for all code blocks
-const defaultFenceRenderer = md.renderer.rules.fence;
-md.renderer.rules.fence = function(tokens, idx, options, env, self) {
-  const token = tokens[idx];
-  
-  // Escape HTML entities to prevent rendering
-  const escapedContent = token.content
-    .replace(/&/g, '&amp;')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
-    .replace(/'/g, '&#39;');
-  
-  // If no language is specified, preserve the original content without processing
-  if (!token.info || token.info.trim() === '') {
-    return '<pre class="hljs"><code>' + escapedContent + '</code></pre>';
-  }
-  
-  // For all language blocks, preserve the original content to avoid processing HTML or other content
-  // This ensures code blocks are treated as literal text only
-  const language = token.info.trim();
-  return '<pre class="hljs"><code class="language-' + language + '">' + escapedContent + '</code></pre>';
-};
+  // Register the enhanced rules
+  md.block.ruler.before('fence', 'steps_container', stepsContainerRule, {
+    alt: ['paragraph', 'reference', 'blockquote', 'list']
+  });
+  md.block.ruler.before('fence', 'enhanced_tabs', enhancedTabsRule, {
+    alt: ['paragraph', 'reference', 'blockquote', 'list']
+  });
+  md.block.ruler.before('paragraph', 'advanced_container', advancedContainerRule, {
+    alt: ['paragraph', 'reference', 'blockquote', 'list']
+  });
 
+  // Register all custom renderers
+  md.renderer.rules.ordered_list_open = customOrderedListOpenRenderer;
+  md.renderer.rules.list_item_open = customListItemOpenRenderer;
+  md.renderer.rules.image = customImageRenderer;
+  
+  // Register tabs renderers
+  md.renderer.rules.tabs_open = tabsOpenRenderer;
+  md.renderer.rules.tabs_nav_open = tabsNavOpenRenderer;
+  md.renderer.rules.tabs_nav_close = tabsNavCloseRenderer;
+  md.renderer.rules.tabs_nav_item = tabsNavItemRenderer;
+  md.renderer.rules.tabs_content_open = tabsContentOpenRenderer;
+  md.renderer.rules.tabs_content_close = tabsContentCloseRenderer;
+  md.renderer.rules.tab_pane_open = tabPaneOpenRenderer;
+  md.renderer.rules.tab_pane_close = tabPaneCloseRenderer;
+  md.renderer.rules.tabs_close = tabsCloseRenderer;
+  
+  // Register heading ID plugin
+  md.use(headingIdPlugin);
+  
+  // Register standalone closing rule
+  md.block.ruler.before('paragraph', 'standalone_closing', standaloneClosingRule, {
+    alt: ['paragraph', 'reference', 'blockquote', 'list']
+  });
 
+  return md;
+}
 
 // ===================================================================
 // --- ADVANCED NESTED CONTAINER SYSTEM ---
@@ -164,8 +185,6 @@ const containers = {
   // }
 };
 
-
-
 // Advanced container rule with proper nesting support
 function advancedContainerRule(state, startLine, endLine, silent) {
   const start = state.bMarks[startLine] + state.tShift[startLine];
@@ -452,7 +471,7 @@ function enhancedTabsRule(state, startLine, endLine, silent) {
                      '</code></pre>';
             } catch (e) { console.error(`Error highlighting language ${lang}:`, e); }
           }
-          return '<pre class="hljs"><code>' + str + '</code></pre>';
+          return '<pre class="hljs"><code>' + MarkdownIt.utils.escapeHtml(str) + '</code></pre>';
         }
       });
       
@@ -481,6 +500,30 @@ function enhancedTabsRule(state, startLine, endLine, silent) {
         alt: ['paragraph', 'reference', 'blockquote', 'list']
       });
       
+      // Register custom renderers for the tab markdown instance
+      tabMd.renderer.rules.ordered_list_open = customOrderedListOpenRenderer;
+      tabMd.renderer.rules.list_item_open = customListItemOpenRenderer;
+      tabMd.renderer.rules.image = customImageRenderer;
+      
+      // Register tabs renderers for the tab markdown instance
+      tabMd.renderer.rules.tabs_open = tabsOpenRenderer;
+      tabMd.renderer.rules.tabs_nav_open = tabsNavOpenRenderer;
+      tabMd.renderer.rules.tabs_nav_close = tabsNavCloseRenderer;
+      tabMd.renderer.rules.tabs_nav_item = tabsNavItemRenderer;
+      tabMd.renderer.rules.tabs_content_open = tabsContentOpenRenderer;
+      tabMd.renderer.rules.tabs_content_close = tabsContentCloseRenderer;
+      tabMd.renderer.rules.tab_pane_open = tabPaneOpenRenderer;
+      tabMd.renderer.rules.tab_pane_close = tabPaneCloseRenderer;
+      tabMd.renderer.rules.tabs_close = tabsCloseRenderer;
+      
+      // Register heading ID plugin for the tab markdown instance
+      tabMd.use(headingIdPlugin);
+      
+      // Register standalone closing rule for the tab markdown instance
+      tabMd.block.ruler.before('paragraph', 'standalone_closing', standaloneClosingRule, {
+        alt: ['paragraph', 'reference', 'blockquote', 'list']
+      });
+      
       // Render the tab content
       const renderedContent = tabMd.render(tabContent);
       const htmlToken = state.push('html_block', '', 0);
@@ -495,19 +538,8 @@ function enhancedTabsRule(state, startLine, endLine, silent) {
   return true;
 }
 
-// Register the enhanced rules
-md.block.ruler.before('fence', 'steps_container', stepsContainerRule, {
-  alt: ['paragraph', 'reference', 'blockquote', 'list']
-});
-md.block.ruler.before('fence', 'enhanced_tabs', enhancedTabsRule, {
-  alt: ['paragraph', 'reference', 'blockquote', 'list']
-});
-md.block.ruler.before('paragraph', 'advanced_container', advancedContainerRule, {
-  alt: ['paragraph', 'reference', 'blockquote', 'list']
-});
-
 // Add a rule to handle standalone closing tags
-md.block.ruler.before('paragraph', 'standalone_closing', (state, startLine, endLine, silent) => {
+const standaloneClosingRule = (state, startLine, endLine, silent) => {
   const start = state.bMarks[startLine] + state.tShift[startLine];
   const max = state.eMarks[startLine];
   const lineContent = state.src.slice(start, max).trim();
@@ -520,19 +552,10 @@ md.block.ruler.before('paragraph', 'standalone_closing', (state, startLine, endL
   }
   
   return false;
-}, {
-  alt: ['paragraph', 'reference', 'blockquote', 'list']
-});
-
-// Register renderers for all containers
-Object.keys(containers).forEach(containerName => {
-  const container = containers[containerName];
-  md.renderer.rules[`container_${containerName}_open`] = container.render;
-  md.renderer.rules[`container_${containerName}_close`] = container.render;
-});
+};
 
 // Custom renderer for ordered lists in steps containers
-md.renderer.rules.ordered_list_open = function(tokens, idx, options, env, self) {
+const customOrderedListOpenRenderer = function(tokens, idx, options, env, self) {
   const token = tokens[idx];
   // Check if we're inside a steps container by looking at the context
   let isInSteps = false;
@@ -561,7 +584,7 @@ md.renderer.rules.ordered_list_open = function(tokens, idx, options, env, self)
 };
 
 // Custom renderer for list items in steps containers
-md.renderer.rules.list_item_open = function(tokens, idx, options, env, self) {
+const customListItemOpenRenderer = function(tokens, idx, options, env, self) {
   const token = tokens[idx];
   // Check if we're inside a steps container and this is a direct child
   let isInStepsList = false;
@@ -596,34 +619,34 @@ md.renderer.rules.list_item_open = function(tokens, idx, options, env, self) {
 };
 
 // Enhanced tabs renderers
-md.renderer.rules.tabs_open = (tokens, idx) => {
+const tabsOpenRenderer = (tokens, idx) => {
   const token = tokens[idx];
   return `<div class="${token.attrs.map(attr => attr[1]).join(' ')}">`;
 };
 
-md.renderer.rules.tabs_nav_open = () => '<div class="docmd-tabs-nav">';
-md.renderer.rules.tabs_nav_close = () => '</div>';
+const tabsNavOpenRenderer = () => '<div class="docmd-tabs-nav">';
+const tabsNavCloseRenderer = () => '</div>';
 
-md.renderer.rules.tabs_nav_item = (tokens, idx) => {
+const tabsNavItemRenderer = (tokens, idx) => {
   const token = tokens[idx];
   return `<div class="${token.attrs[0][1]}">${token.content}</div>`;
 };
 
-md.renderer.rules.tabs_content_open = () => '<div class="docmd-tabs-content">';
-md.renderer.rules.tabs_content_close = () => '</div>';
+const tabsContentOpenRenderer = () => '<div class="docmd-tabs-content">';
+const tabsContentCloseRenderer = () => '</div>';
 
-md.renderer.rules.tab_pane_open = (tokens, idx) => {
+const tabPaneOpenRenderer = (tokens, idx) => {
   const token = tokens[idx];
   return `<div class="${token.attrs[0][1]}">`;
 };
 
-md.renderer.rules.tab_pane_close = () => '</div>';
+const tabPaneCloseRenderer = () => '</div>';
 
-md.renderer.rules.tabs_close = () => '</div>';
+const tabsCloseRenderer = () => '</div>';
 
 // Override the default image renderer to properly handle attributes like {.class}.
-const defaultImageRenderer = md.renderer.rules.image;
-md.renderer.rules.image = function(tokens, idx, options, env, self) {
+const customImageRenderer = function(tokens, idx, options, env, self) {
+  const defaultImageRenderer = function(tokens, idx, options, env, self) { return self.renderToken(tokens, idx, options); };
   const renderedImage = defaultImageRenderer(tokens, idx, options, env, self);
   const nextToken = tokens[idx + 1];
   if (nextToken && nextToken.type === 'attrs_block') {
@@ -635,22 +658,33 @@ md.renderer.rules.image = function(tokens, idx, options, env, self) {
 };
 
 // Add IDs to headings for anchor links, used by the Table of Contents.
-md.use((md) => {
-  const defaultRender = md.renderer.rules.heading_open || function(tokens, idx, options, env, self) {
+const headingIdPlugin = (md) => {
+  const originalHeadingOpen = md.renderer.rules.heading_open || function(tokens, idx, options, env, self) {
     return self.renderToken(tokens, idx, options);
   };
+
   md.renderer.rules.heading_open = function(tokens, idx, options, env, self) {
     const token = tokens[idx];
     const contentToken = tokens[idx + 1];
-    if (contentToken && contentToken.type === 'inline') {
+
+    if (contentToken && contentToken.type === 'inline' && contentToken.content) {
       const headingText = contentToken.content;
-      const id = headingText.toLowerCase().replace(/\s+/g, '-').replace(/[^\w-]/g, '').replace(/--+/g, '-').replace(/^-+|-+$/g, '');
-      if (id) { token.attrSet('id', id); }
+      const id = headingText
+        .toLowerCase()
+        .replace(/\s+/g, '-') // Replace spaces with -
+        .replace(/[^\w-]+/g, '') // Remove all non-word chars
+        .replace(/--+/g, '-') // Replace multiple - with single -
+        .replace(/^-+/, '') // Trim - from start of text
+        .replace(/-+$/, ''); // Trim - from end of text
+      
+      if (id) {
+        token.attrSet('id', id);
+      }
     }
-    return defaultRender(tokens, idx, options, env, self);
+    
+    return originalHeadingOpen(tokens, idx, options, env, self);
   };
-});
-
+};
 
 // ===================================================================
 // --- SAFE CONTAINER WRAPPER (FOR SIMPLE CONTAINERS) ---
@@ -685,13 +719,21 @@ function extractHeadingsFromHtml(htmlContent) {
   return headings;
 }
 
-async function processMarkdownFile(filePath, options = { isDev: false }, config) {
+async function processMarkdownFile(filePath, md, config) {
   const rawContent = await fs.readFile(filePath, 'utf8');
-  let { data: frontmatter, content: markdownContent } = matter(rawContent);
+  let frontmatter, markdownContent;
+
+  try {
+    ({ data: frontmatter, content: markdownContent } = matter(rawContent));
+  } catch (e) {
+    console.error(`❌ Error parsing frontmatter in ${formatPathForDisplay(filePath)}:`);
+    console.error(`   ${e.message}`);
+    console.error('   This page will be skipped. Please fix the YAML syntax.');
+    return null;
+  }
 
-  // Handle autoTitleFromH1
   if (!frontmatter.title) {
-    if (config.autoTitleFromH1 !== false) { // Default to true
+    if (config.autoTitleFromH1 !== false) {
         const h1Match = markdownContent.match(/^#\s+(.*)/m);
         if (h1Match && h1Match[1]) {
             frontmatter.title = h1Match[1].trim();
@@ -702,11 +744,12 @@ async function processMarkdownFile(filePath, options = { isDev: false }, config)
     }
   }
 
-  // For no-style pages, skip markdown processing and treat content as raw HTML
   let htmlContent, headings;
   if (frontmatter.noStyle === true) {
-    htmlContent = markdownContent; // Use raw content as HTML
-    headings = []; // No headings extraction for no-style pages
+    // For noStyle pages, NO markdown processing at all
+    // Pass the raw content directly as-is
+    htmlContent = markdownContent;
+    headings = [];
   } else {
     htmlContent = md.render(markdownContent);
     headings = extractHeadingsFromHtml(htmlContent);
@@ -735,7 +778,7 @@ async function findMarkdownFiles(dir) {
 
 module.exports = {
   processMarkdownFile,
-  mdInstance: md,
+  createMarkdownItInstance,
   extractHeadingsFromHtml,
   findMarkdownFiles
 };

package/src/core/html-generator.js

@@ -1,38 +1,51 @@
-// src/core/html-generator.js
+//
+
 const ejs = require('ejs');
 const path = require('path');
 const fs = require('fs-extra');
-const { mdInstance } = require('./file-processor'); // Import mdInstance for footer
+const { createMarkdownItInstance } = require('./file-processor');
 const { generateSeoMetaTags } = require('../plugins/seo');
 const { generateAnalyticsScripts } = require('../plugins/analytics');
-const { renderIcon } = require('./icon-renderer'); // Import icon renderer
+const { renderIcon } = require('./icon-renderer');
+
+// Create a markdown instance for inline rendering
+let mdInstance = null;
+
+let themeInitScript = '';
+(async () => {
+    const themeInitPath = path.join(__dirname, '..', 'templates', 'partials', 'theme-init.js');
+    if (await fs.pathExists(themeInitPath)) {
+        const scriptContent = await fs.readFile(themeInitPath, 'utf8');
+        themeInitScript = `<script>${scriptContent}</script>`;
+    }
+})();
 
 async function processPluginHooks(config, pageData, relativePathToRoot) {
     let metaTagsHtml = '';
     let faviconLinkHtml = '';
-    let themeCssLinkHtml = ''; // For theme.name CSS file
-    let pluginStylesHtml = ''; // For plugin-specific CSS
+    let themeCssLinkHtml = '';
+    let pluginStylesHtml = '';
     let pluginHeadScriptsHtml = '';
     let pluginBodyScriptsHtml = '';
 
-    // 1. Favicon (built-in handling)
+    // Favicon (built-in handling)
     if (config.favicon) {
         const faviconPath = config.favicon.startsWith('/') ? config.favicon.substring(1) : config.favicon;
         faviconLinkHtml = `<link rel="shortcut icon" href="${relativePathToRoot}${faviconPath}" type="image/x-icon">\n`;
     }
 
-    // 2. Theme CSS (built-in handling for theme.name)
+    // Theme CSS (built-in handling for theme.name)
     if (config.theme && config.theme.name && config.theme.name !== 'default') {
         const themeCssPath = `assets/css/docmd-theme-${config.theme.name}.css`;
         themeCssLinkHtml = `  <link rel="stylesheet" href="${relativePathToRoot}${themeCssPath}">\n`;
     }
 
-    // 3. SEO Plugin (if configured)
+    // SEO Plugin (if configured)
     if (config.plugins?.seo) {
         metaTagsHtml += generateSeoMetaTags(config, pageData, relativePathToRoot);
     }
 
-    // 4. Analytics Plugin (if configured)
+    // Analytics Plugin (if configured)
     if (config.plugins?.analytics) {
         const analyticsScripts = generateAnalyticsScripts(config, pageData);
         pluginHeadScriptsHtml += analyticsScripts.headScriptsHtml;
@@ -56,17 +69,21 @@ async function generateHtmlPage(templateData) {
         prevPage, nextPage, currentPagePath, headings
     } = templateData;
 
-    const pageTitle = frontmatter.title; // Get title from frontmatter (already processed in file-processor)
+    const pageTitle = frontmatter.title;
 
     // Process plugins to get their HTML contributions
     const pluginOutputs = await processPluginHooks(
         config,
-        { frontmatter, outputPath }, // pageData object
+        { frontmatter, outputPath },
         relativePathToRoot
     );
 
     let footerHtml = '';
     if (config.footer) {
+        // Initialize mdInstance if not already done
+        if (!mdInstance) {
+            mdInstance = createMarkdownItInstance(config);
+        }
         footerHtml = mdInstance.renderInline(config.footer);
     }
 
@@ -85,7 +102,8 @@ async function generateHtmlPage(templateData) {
 
     const ejsData = {
         content,
-        pageTitle, // Pass the potentially undefined title
+        pageTitle,
+        themeInitScript,
         description: frontmatter.description,
         siteTitle,
         navigationHtml,
@@ -109,6 +127,7 @@ async function generateHtmlPage(templateData) {
         headings: headings || [],
         isActivePage,
         frontmatter,
+        config: config,
         ...pluginOutputs,
     };
 

package/src/core/icon-renderer.js

@@ -1,5 +1,6 @@
-// src/core/icon-renderer.js
-const lucideStatic = require('lucide-static'); // Access the raw icon data
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+const lucideStatic = require('lucide-static');
 
 // On first load, log debug information about a specific icon to understand its structure
 let debugRun = false;

package/src/plugins/analytics.js

@@ -1,4 +1,8 @@
-// src/plugins/analytics.js
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+/*
+ * Generate analytics scripts for a page
+ */
 
 function generateAnalyticsScripts(config, pageData) {
     let headScriptsHtml = '';