@mgks/docmd 0.2.0 → 0.2.1

package/src/plugins/seo.js

@@ -1,69 +1,117 @@
-// src/plugins/seo.js
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+/*
+ * Generate SEO meta tags for a page
+ */
+
 function generateSeoMetaTags(config, pageData, relativePathToRoot) {
-    let metaTagsHtml = '';
-    const { frontmatter, outputPath } = pageData;
-  
-    if (frontmatter.noindex) {
-      metaTagsHtml += '  <meta name="robots" content="noindex">\n';
-      return metaTagsHtml; // No other SEO tags if noindex
-    }
-  
-    const siteTitle = config.siteTitle;
-    const pageTitle = frontmatter.title || 'Untitled'; // Ensure pageTitle is always defined
-    const description = frontmatter.description || config.plugins?.seo?.defaultDescription || '';
-  
-    // Construct pageUrl - ensure siteUrl in config has no trailing slash
-    const siteUrl = config.siteUrl ? config.siteUrl.replace(/\/$/, '') : '';
-    const pageSegment = outputPath.replace(/index\.html$/, '').replace(/\.html$/, '');
-    const pageUrl = `${siteUrl}${pageSegment.startsWith('/') ? pageSegment : '/' + pageSegment}`;
-  
-    metaTagsHtml += `  <meta name="description" content="${description}">\n`;
-  
-    // Canonical URL - use permalink first, fall back to canonicalUrl, then default to pageUrl
-    const canonicalUrl = frontmatter.permalink || frontmatter.canonicalUrl || pageUrl;
-    metaTagsHtml += `  <link rel="canonical" href="${canonicalUrl}">\n`;
-  
-    // Open Graph
-    metaTagsHtml += `  <meta property="og:title" content="${pageTitle} | ${siteTitle}">\n`;
-    metaTagsHtml += `  <meta property="og:description" content="${description}">\n`;
-    metaTagsHtml += `  <meta property="og:url" content="${pageUrl}">\n`;
-    metaTagsHtml += `  <meta property="og:site_name" content="${config.plugins?.seo?.openGraph?.siteName || siteTitle}">\n`;
-  
-    const ogImage = frontmatter.image || frontmatter.ogImage || config.plugins?.seo?.openGraph?.defaultImage;
-    if (ogImage) {
-      const ogImageUrl = ogImage.startsWith('http') ? ogImage : `${siteUrl}${ogImage.startsWith('/') ? ogImage : '/' + ogImage}`;
-      metaTagsHtml += `  <meta property="og:image" content="${ogImageUrl}">\n`;
-    }
-    metaTagsHtml += `  <meta property="og:type" content="${frontmatter.ogType || 'website'}">\n`;
-  
-    // Twitter Card
-    const twitterCardType = frontmatter.twitterCard || config.plugins?.seo?.twitter?.cardType || 'summary';
-    metaTagsHtml += `  <meta name="twitter:card" content="${twitterCardType}">\n`;
-    if (config.plugins?.seo?.twitter?.siteUsername) {
-      metaTagsHtml += `  <meta name="twitter:site" content="${config.plugins.seo.twitter.siteUsername}">\n`;
-    }
-    const twitterCreator = frontmatter.twitterCreator || config.plugins?.seo?.twitter?.creatorUsername;
-    if (twitterCreator) {
-      metaTagsHtml += `  <meta name="twitter:creator" content="${twitterCreator}">\n`;
-    }
-    // Twitter title, description, image often fallback to OG tags if not explicitly set by Twitter.
-    // For explicitness:
-    metaTagsHtml += `  <meta name="twitter:title" content="${pageTitle} | ${siteTitle}">\n`;
-    metaTagsHtml += `  <meta name="twitter:description" content="${description}">\n`;
-    if (ogImage) { // Re-use ogImage for twitter:image if not specified differently
-      const twitterImageUrl = ogImage.startsWith('http') ? ogImage : `${siteUrl}${ogImage.startsWith('/') ? ogImage : '/' + ogImage}`;
-      metaTagsHtml += `  <meta name="twitter:image" content="${twitterImageUrl}">\n`;
-    }
-  
-  
-    // Keywords (optional, less impact nowadays)
-    if (frontmatter.keywords) {
-      const keywordsString = Array.isArray(frontmatter.keywords) ? frontmatter.keywords.join(', ') : frontmatter.keywords;
-      metaTagsHtml += `  <meta name="keywords" content="${keywordsString}">\n`;
+  let metaTagsHtml = '';
+  const { frontmatter, outputPath } = pageData;
+  const seoFrontmatter = frontmatter.seo || {}; // Use nested seo object, fallback to empty
+
+  if (frontmatter.noindex || seoFrontmatter.noindex) {
+    metaTagsHtml += '  <meta name="robots" content="noindex">\n';
+    return metaTagsHtml; // No other SEO tags if noindex
+  }
+
+  const siteTitle = config.siteTitle;
+  const pageTitle = frontmatter.title || 'Untitled';
+  const description = seoFrontmatter.description || frontmatter.description || config.plugins?.seo?.defaultDescription || '';
+
+  const siteUrl = config.siteUrl ? config.siteUrl.replace(/\/$/, '') : '';
+  const pageSegment = outputPath.replace(/index\.html$/, '').replace(/\.html$/, '');
+  const pageUrl = `${siteUrl}${pageSegment.startsWith('/') ? pageSegment : '/' + pageSegment}`;
+
+  metaTagsHtml += `  <meta name="description" content="${description}">\n`;
+
+  const canonicalUrl = seoFrontmatter.permalink || frontmatter.permalink || seoFrontmatter.canonicalUrl || frontmatter.canonicalUrl || pageUrl;
+  metaTagsHtml += `  <link rel="canonical" href="${canonicalUrl}">\n`;
+
+  // Open Graph
+  metaTagsHtml += `  <meta property="og:title" content="${pageTitle} | ${siteTitle}">\n`;
+  metaTagsHtml += `  <meta property="og:description" content="${description}">\n`;
+  metaTagsHtml += `  <meta property="og:url" content="${pageUrl}">\n`;
+  metaTagsHtml += `  <meta property="og:site_name" content="${config.plugins?.seo?.openGraph?.siteName || siteTitle}">\n`;
+
+  const ogImage = seoFrontmatter.image || frontmatter.image || seoFrontmatter.ogImage || frontmatter.ogImage || config.plugins?.seo?.openGraph?.defaultImage;
+  if (ogImage) {
+    const ogImageUrl = ogImage.startsWith('http') ? ogImage : `${siteUrl}${ogImage.startsWith('/') ? ogImage : '/' + ogImage}`;
+    metaTagsHtml += `  <meta property="og:image" content="${ogImageUrl}">\n`;
+  }
+  metaTagsHtml += `  <meta property="og:type" content="${seoFrontmatter.ogType || frontmatter.ogType || 'website'}">\n`;
+
+  // Twitter Card
+  const twitterCardType = seoFrontmatter.twitterCard || frontmatter.twitterCard || config.plugins?.seo?.twitter?.cardType || 'summary';
+  metaTagsHtml += `  <meta name="twitter:card" content="${twitterCardType}">\n`;
+  if (config.plugins?.seo?.twitter?.siteUsername) {
+    metaTagsHtml += `  <meta name="twitter:site" content="${config.plugins.seo.twitter.siteUsername}">\n`;
+  }
+  const twitterCreator = seoFrontmatter.twitterCreator || frontmatter.twitterCreator || config.plugins?.seo?.twitter?.creatorUsername;
+  if (twitterCreator) {
+    metaTagsHtml += `  <meta name="twitter:creator" content="${twitterCreator}">\n`;
+  }
+  metaTagsHtml += `  <meta name="twitter:title" content="${pageTitle} | ${siteTitle}">\n`;
+  metaTagsHtml += `  <meta name="twitter:description" content="${description}">\n`;
+  if (ogImage) {
+    const twitterImageUrl = ogImage.startsWith('http') ? ogImage : `${siteUrl}${ogImage.startsWith('/') ? ogImage : '/' + ogImage}`;
+    metaTagsHtml += `  <meta name="twitter:image" content="${twitterImageUrl}">\n`;
+  }
+
+  // Keywords
+  const keywords = seoFrontmatter.keywords || frontmatter.keywords;
+  if (keywords) {
+    const keywordsString = Array.isArray(keywords) ? keywords.join(', ') : keywords;
+    metaTagsHtml += `  <meta name="keywords" content="${keywordsString}">\n`;
+  }
+
+  // LD+JSON Structured Data
+  const ldJsonConfig = seoFrontmatter.ldJson || frontmatter.ldJson;
+  if (ldJsonConfig) {
+    try {
+      const baseLdJson = {
+        '@context': 'https://schema.org',
+        '@type': 'Article',
+        mainEntityOfPage: {
+          '@type': 'WebPage',
+          '@id': canonicalUrl,
+        },
+        headline: pageTitle,
+        description: description,
+        url: canonicalUrl,
+      };
+
+      if (config.siteTitle) {
+        baseLdJson.publisher = {
+          '@type': 'Organization',
+          name: config.siteTitle,
+        };
+        if (config.logo?.light) {
+          baseLdJson.publisher.logo = {
+            '@type': 'ImageObject',
+            url: `${siteUrl}${config.logo.light.startsWith('/') ? config.logo.light : '/' + config.logo.light}`
+          };
+        }
+      }
+      
+      if (ogImage) {
+        baseLdJson.image = `${siteUrl}${ogImage.startsWith('/') ? ogImage : '/' + ogImage}`;
+      }
+
+      const finalLdJson = typeof ldJsonConfig === 'object' 
+        ? { ...baseLdJson, ...ldJsonConfig } 
+        : baseLdJson;
+
+      metaTagsHtml += `  <script type="application/ld+json">\n`;
+      metaTagsHtml += `    ${JSON.stringify(finalLdJson, null, 2)}\n`;
+      metaTagsHtml += `  </script>\n`;
+    } catch (e) {
+      console.error(`❌ Error generating LD+JSON for page: ${outputPath}`);
+      console.error(`   Could not stringify the ldJson object. Please check its structure in the frontmatter.`);
+      console.error(`   ${e.message}`);
     }
-  
-  
-    return metaTagsHtml;
   }
-  
-  module.exports = { generateSeoMetaTags };
+
+  return metaTagsHtml;
+}
+
+module.exports = { generateSeoMetaTags };

package/src/plugins/sitemap.js

@@ -1,3 +1,9 @@
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+/*
+ * Generate sitemap.xml in the output directory root
+ */
+
 const fs = require('fs-extra');
 const path = require('path');
 

package/src/templates/layout.ejs

@@ -13,9 +13,13 @@
 
     <%- faviconLinkHtml || '' %> <%# Favicon %>
 
+    <%- themeInitScript %>
+
     <link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/docmd-main.css">
 
-    <link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/docmd-highlight-<%= defaultMode === 'dark' ? 'dark' : 'light' %>.css" id="highlight-theme">
+    <% if (config.theme?.codeHighlight !== false) { %>
+        <link rel="stylesheet" id="highlight-theme" href="<%= relativePathToRoot %>assets/css/docmd-highlight-<%= defaultMode === 'dark' ? 'dark' : 'light' %>.css" data-base-href="<%= relativePathToRoot %>assets/css/">
+    <% } %>
 
     <%- themeCssLinkHtml || '' %> <%# For theme.name specific CSS %>
 
@@ -27,7 +31,9 @@
 
     <%- pluginHeadScriptsHtml || '' %> <%# Plugin specific head scripts (e.g., Analytics) %>
 </head>
-<body class="<%= sidebarConfig.collapsible ? 'sidebar-collapsible' : 'sidebar-not-collapsible' %>" data-theme="<%= defaultMode %>" data-default-collapsed="<%= sidebarConfig.defaultCollapsed %>">
+<body class="<%= sidebarConfig.collapsible ? 'sidebar-collapsible' : 'sidebar-not-collapsible' %>"
+    data-theme="<%= defaultMode %>" data-default-collapsed="<%= sidebarConfig.defaultCollapsed %>"
+    data-copy-code-enabled="<%= config.copyCode === true %>">
     <aside class="sidebar">
         <div class="sidebar-header">
             <% if (logo && logo.light && logo.dark) { %>

package/src/templates/no-style.ejs

@@ -16,6 +16,10 @@
         <%- faviconLinkHtml || '' %>
     <% } %>
 
+    <% if (frontmatter.components?.themeMode !== false) { %>
+        <%- themeInitScript %>
+    <% } %>
+
     <% if (frontmatter.components?.css !== false) { %>
         <link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/docmd-main.css">
         <% if (frontmatter.components?.highlight !== false) { %>
@@ -45,7 +49,16 @@
         <%- frontmatter.customHead %>
     <% } %>
 </head>
-<body<% if (frontmatter.components?.theme !== false) { %> data-theme="<%= defaultMode %>"<% } %><% if (frontmatter.bodyClass) { %> class="<%= frontmatter.bodyClass %>"<% } %>>
+<body
+    <%
+    if (frontmatter.components?.theme !== false) {
+        %> data-theme="<%= defaultMode %>"<%
+    }
+    %><%
+    if (frontmatter.bodyClass) {
+        %> class="<%= frontmatter.bodyClass %>"<%
+    }
+    %> data-copy-code-enabled="<%= config.copyCode === true %>">
     <% if (frontmatter.components?.layout === true || frontmatter.components?.layout === 'full') { %>
         <div class="main-content-wrapper">
             <% if (frontmatter.components?.header !== false) { %>
@@ -136,18 +149,22 @@
         <%- content %>
     <% } %>
 
-    <% if (frontmatter.components?.scripts !== false) { %>
-        <% if (frontmatter.components?.themeToggle !== false) { %>
-            <script src="<%= relativePathToRoot %>assets/js/docmd-theme-toggle.js"></script>
+    <% if (frontmatter.components?.scripts === true) { %>
+        <% if (frontmatter.components?.mainScripts === true) { %>
+            <script src="<%= relativePathToRoot %>assets/js/docmd-main.js"></script>
+        <% } %>
+        
+        <% if (frontmatter.components?.lightbox === true && frontmatter.components?.mainScripts === true) { %>
+            <script src="<%= relativePathToRoot %>assets/js/docmd-image-lightbox.js"></script>
         <% } %>
         
-        <% if (frontmatter.components?.customJs !== false && customJsFiles && customJsFiles.length > 0) { %>
+        <% if (frontmatter.components?.customJs === true && customJsFiles && customJsFiles.length > 0) { %>
             <% customJsFiles.forEach(jsFile => { %>
                 <script src="<%= relativePathToRoot %><%- jsFile.startsWith('/') ? jsFile.substring(1) : jsFile %>"></script>
             <% }); %>
         <% } %>
         
-        <% if (frontmatter.components?.pluginBodyScripts !== false) { %>
+        <% if (frontmatter.components?.pluginBodyScripts === true) { %>
             <%- pluginBodyScriptsHtml || '' %>
         <% } %>
     <% } %>

package/src/templates/partials/theme-init.js

@@ -0,0 +1,26 @@
+// Source file from the docmd project — https://github.com/mgks/docmd
+
+/*
+ * Initialize the theme from localStorage
+ */
+
+(function() {
+    try {
+      const storedTheme = localStorage.getItem('docmd-theme');
+      if (storedTheme) {
+        document.documentElement.setAttribute('data-theme', storedTheme);
+        
+        // Also update highlight CSS link to match the stored theme
+        const highlightThemeLink = document.getElementById('highlight-theme');
+        if (highlightThemeLink) {
+          const baseHref = highlightThemeLink.getAttribute('data-base-href');
+          if (baseHref) {
+            const newHref = baseHref + `docmd-highlight-${storedTheme}.css`;
+            highlightThemeLink.setAttribute('href', newHref);
+          }
+        }
+      }
+    } catch (e) {
+      console.error('Error applying theme from localStorage', e);
+    }
+})();