@mgks/docmd 0.1.0 → 0.1.2

package/src/core/html-generator.js

@@ -23,8 +23,8 @@ async function processPluginHooks(config, pageData, relativePathToRoot) {
 
     // 2. Theme CSS (built-in handling for theme.name)
     if (config.theme && config.theme.name && config.theme.name !== 'default') {
-        // Assumes theme CSS files are like 'theme-yourthemename.css' in assets/css
-        const themeCssPath = `assets/css/theme-${config.theme.name}.css`;
+        // Assumes theme CSS files are like 'docmd-theme-yourthemename.css' in assets/css
+        const themeCssPath = `assets/css/docmd-theme-${config.theme.name}.css`;
         // Check if theme file exists before linking (optional, good practice)
         // For now, assume it will exist if specified.
         themeCssLinkHtml = `  <link rel="stylesheet" href="${relativePathToRoot}${themeCssPath}">\n`;
@@ -109,7 +109,9 @@ async function generateHtmlPage(templateData) {
     };
 
     try {
-        return ejs.render(layoutTemplate, ejsData);
+        return ejs.render(layoutTemplate, ejsData, {
+            filename: layoutTemplatePath // Add filename for proper include resolution
+        });
     } catch (e) {
         console.error(`❌ Error rendering EJS template for ${outputPath}: ${e.message}`);
         console.error("EJS Data:", JSON.stringify(ejsData, null, 2).substring(0, 1000) + "..."); // Log partial data
@@ -133,6 +135,8 @@ async function generateNavigationHtml(navItems, currentPagePath, relativePathToR
         relativePathToRoot,
         config, // Pass full config if needed by nav (e.g. for base path)
         ...ejsHelpers
+    }, {
+        filename: navTemplatePath // Add filename for proper include resolution
     });
 }
 

package/src/plugins/sitemap.js

@@ -6,11 +6,15 @@ const path = require('path');
  * @param {Object} config - The full configuration object
  * @param {Array} pages - Array of page objects with data about each processed page
  * @param {string} outputDir - Path to the output directory
+ * @param {Object} options - Additional options
+ * @param {boolean} options.isDev - Whether running in development mode
  */
-async function generateSitemap(config, pages, outputDir) {
+async function generateSitemap(config, pages, outputDir, options = { isDev: false }) {
   // Skip if no siteUrl is defined (sitemap needs absolute URLs)
   if (!config.siteUrl) {
-    console.warn('⚠️ No siteUrl defined in config. Skipping sitemap generation.');
+    if (!options.isDev) {
+      console.warn('⚠️ No siteUrl defined in config. Skipping sitemap generation.');
+    }
     return;
   }
 
@@ -94,7 +98,10 @@ async function generateSitemap(config, pages, outputDir) {
   const sitemapPath = path.join(outputDir, 'sitemap.xml');
   await fs.writeFile(sitemapPath, sitemapXml);
   
-  console.log(`✅ Generated sitemap at ${sitemapPath}`);
+  // Only show sitemap generation message in production mode or if DOCMD_DEV is true
+  if (!options.isDev || process.env.DOCMD_DEV === 'true') {
+    console.log(`✅ Generated sitemap at ${sitemapPath}`);
+  }
 }
 
 module.exports = { generateSitemap }; 

package/src/templates/layout.ejs

@@ -13,9 +13,9 @@
 
     <%- faviconLinkHtml || '' %> <%# Favicon %>
 
-    <link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/main.css">
+    <link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/docmd-main.css">
 
-    <link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/highlight-<%= defaultMode === 'dark' ? 'dark' : 'light' %>.css" id="highlight-theme">
+    <link rel="stylesheet" href="<%= relativePathToRoot %>assets/css/docmd-highlight-<%= defaultMode === 'dark' ? 'dark' : 'light' %>.css" id="highlight-theme">
 
     <%- themeCssLinkHtml || '' %> <%# For theme.name specific CSS %>
 
@@ -90,65 +90,7 @@
                 
                 <!-- TOC sidebar -->
                 <div class="toc-sidebar">
-                    <% 
-                    // Helper function to decode HTML entities
-                    function decodeHtmlEntities(html) {
-                      return html
-                        .replace(/&amp;/g, '&')
-                        .replace(/&lt;/g, '<')
-                        .replace(/&gt;/g, '>')
-                        .replace(/&quot;/g, '"')
-                        .replace(/&#39;/g, "'")
-                        .replace(/&nbsp;/g, ' ');
-                    }
-                    
-                    // Only show TOC on active pages
-                    const isActive = navigationHtml && navigationHtml.includes('class="active"');
-                    
-                    if (isActive) {
-                      // Extract headings directly from content - match with or without id attribute
-                      const headingRegex = /<h([2-4])[^>]*?(?:id="([^"]*)")?[^>]*?>([\s\S]*?)<\/h\1>/g;
-                      const tocHeadings = [];
-                      let match;
-                      let contentStr = content.toString();
-
-                      while ((match = headingRegex.exec(contentStr)) !== null) {
-                          const level = parseInt(match[1], 10);
-                          // Use ID if available, or generate one from the text
-                          let id = match[2];
-                          // Remove any HTML tags inside the heading text and decode HTML entities
-                          const textWithTags = match[3].replace(/<\/?[^>]+(>|$)/g, '');
-                          // Decode HTML entities
-                          const text = decodeHtmlEntities(textWithTags);
-                          
-                          if (!id) {
-                              // Generate an ID from the heading text if none exists
-                              id = text
-                                .toLowerCase()
-                                .replace(/\s+/g, '-')
-                                .replace(/[^\w-]/g, '')
-                                .replace(/--+/g, '-')
-                                .replace(/^-+|-+$/g, '');
-                          }
-                          
-                          tocHeadings.push({ id, level, text });
-                      }
-                      
-                      // Only show TOC if there are enough headings
-                      if (tocHeadings.length > 1) { 
-                      %>
-                          <div class="toc-container">
-                              <h2 class="toc-title">On This Page</h2>
-                              <ul class="toc-list">
-                                  <% tocHeadings.forEach(heading => { %>
-                                      <li class="toc-item toc-level-<%= heading.level %>">
-                                          <a href="#<%= heading.id %>" class="toc-link"><%- heading.text %></a>
-                                      </li>
-                                  <% }); %>
-                              </ul>
-                          </div>
-                      <% } 
-                    } %>
+                    <%- include('toc', { content, headings, navigationHtml, isActivePage }) %>
                 </div>
             </div>
         </main>
@@ -158,13 +100,13 @@
                     <%- footerHtml || '' %>
                 </div>
                 <div class="branding-footer">
-                    Build with 💜 <a href="https://docmd.mgks.dev" target="_blank" rel="noopener">docmd.</a>
+                    Build with <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M19 14c1.49-1.46 3-3.21 3-5.5A5.5 5.5 0 0 0 16.5 3c-1.76 0-3 .5-4.5 2-1.5-1.5-2.74-2-4.5-2A5.5 5.5 0 0 0 2 8.5c0 2.3 1.5 4.05 3 5.5l7 7Z"></path><path d="M12 5 9.04 7.96a2.17 2.17 0 0 0 0 3.08c.82.82 2.13.85 3 .07l2.07-1.9a2.82 2.82 0 0 1 3.79 0l2.96 2.66"></path><path d="m18 15-2-2"></path><path d="m15 18-2-2"></path></svg> <a href="https://docmd.mgks.dev" target="_blank" rel="noopener">docmd.</a>
                 </div>
             </div>
         </footer>
     </div>
 
-    <script src="<%= relativePathToRoot %>assets/js/theme-toggle.js"></script>
+    <script src="<%= relativePathToRoot %>assets/js/docmd-theme-toggle.js"></script>
     <% (customJsFiles || []).forEach(jsFile => { %>
       <script src="<%= relativePathToRoot %><%- jsFile.startsWith('/') ? jsFile.substring(1) : jsFile %>"></script>
     <% }); %>

package/src/templates/toc.ejs

@@ -1,34 +1,67 @@
 <%# src/templates/toc.ejs %>
 <% 
-// If direct headings aren't available, we'll try to extract them from the content
-let tocHeadings = [];
-if (headings && headings.length > 0) {
-  // Use provided headings if available
-  tocHeadings = headings.filter(h => h.level >= 2 && h.level <= 4);
-} else if (content) {
-  // Basic regex to extract headings from HTML content
-  const headingRegex = /<h([2-4])[^>]*?id="([^"]*)"[^>]*?>([\s\S]*?)<\/h\1>/g;
-  let match;
-  while ((match = headingRegex.exec(content)) !== null) {
-    const level = parseInt(match[1], 10);
-    const id = match[2];
-    // Remove any HTML tags inside the heading text
-    const text = match[3].replace(/<\/?[^>]+(>|$)/g, '');
-    tocHeadings.push({ id, level, text });
-  }
+// Helper function to decode HTML entities
+function decodeHtmlEntities(html) {
+  return html
+    .replace(/&amp;/g, '&')
+    .replace(/&lt;/g, '<')
+    .replace(/&gt;/g, '>')
+    .replace(/&quot;/g, '"')
+    .replace(/&#39;/g, "'")
+    .replace(/&nbsp;/g, ' ');
 }
 
-// Only show TOC if there are enough headings
-if (tocHeadings.length > 1) { 
+// Use the isActivePage flag if provided, otherwise fall back to checking navigationHtml
+const shouldShowToc = typeof isActivePage !== 'undefined' ? isActivePage : 
+                      (typeof navigationHtml !== 'undefined' && navigationHtml && navigationHtml.includes('class="active"'));
+
+if (shouldShowToc) {
+  // If direct headings aren't available, we'll try to extract them from the content
+  let tocHeadings = [];
+  if (headings && headings.length > 0) {
+    // Use provided headings if available
+    tocHeadings = headings.filter(h => h.level >= 2 && h.level <= 4);
+  } else if (content) {
+    // Basic regex to extract headings from HTML content
+    const headingRegex = /<h([2-4])[^>]*?(?:id="([^"]*)")?[^>]*?>([\s\S]*?)<\/h\1>/g;
+    let match;
+    let contentStr = content.toString();
+    
+    while ((match = headingRegex.exec(contentStr)) !== null) {
+      const level = parseInt(match[1], 10);
+      // Use ID if available, or generate one from the text
+      let id = match[2];
+      // Remove any HTML tags inside the heading text
+      const textWithTags = match[3].replace(/<\/?[^>]+(>|$)/g, '');
+      // Decode HTML entities
+      const text = decodeHtmlEntities(textWithTags);
+      
+      if (!id) {
+        // Generate an ID from the heading text if none exists
+        id = text
+          .toLowerCase()
+          .replace(/\s+/g, '-')
+          .replace(/[^\w-]/g, '')
+          .replace(/--+/g, '-')
+          .replace(/^-+|-+$/g, '');
+      }
+      
+      tocHeadings.push({ id, level, text });
+    }
+  }
+
+  // Only show TOC if there are enough headings
+  if (tocHeadings.length > 1) { 
 %>
   <div class="toc-container">
     <h2 class="toc-title">On This Page</h2>
     <ul class="toc-list">
       <% tocHeadings.forEach(heading => { %>
         <li class="toc-item toc-level-<%= heading.level %>">
-          <a href="#<%= heading.id %>" class="toc-link"><%= heading.text %></a>
+          <a href="#<%= heading.id %>" class="toc-link"><%- heading.text %></a>
         </li>
       <% }); %>
     </ul>
   </div>
-<% } %> 
+<% } 
+} %> 

package/docs/writing-content/index.md

@@ -1,17 +0,0 @@
----
-title: "Writing Content with docmd"
-description: "Learn how to write effective documentation using Markdown, frontmatter, and custom components in docmd."
----
-
-# Writing Content
-
-`docmd` is designed to let you focus on your content, written in standard Markdown. This section covers the essentials of creating pages, structuring your content, and leveraging `docmd`'s features to enhance your documentation.
-
-## Key Aspects:
-
-*   **[Frontmatter](/writing-content/frontmatter/):** Define page-specific metadata like titles and descriptions using simple YAML at the top of your Markdown files.
-*   **[Markdown Syntax](/writing-content/markdown-syntax/):** Utilize standard CommonMark and GitHub Flavored Markdown for formatting your text, code blocks, lists, tables, and more.
-*   **[Custom Containers](/writing-content/custom-containers/):** Enhance your pages with special components like callouts, cards, and steps using a simple `::: name :::` syntax.
-*   **[Steps Container](/writing-content/steps-test/):** Create sequential guides with the specialized steps container.
-
-By understanding these elements, you can create rich, well-structured, and engaging documentation.

package/src/assets/css/toc.css

@@ -1,76 +0,0 @@
-/* TOC Styles - Simplified Hyperlink Style */
-.toc-container {
-    margin: 0;
-    padding: 0;
-    border: none;
-    background-color: transparent;
-  }
-  
-  .toc-title {
-      margin-top: 0;
-      margin-bottom: 0.5rem;
-      font-size: 1rem;
-      font-weight: bold;
-      color: var(--text-muted);
-  
-  }
-  
-  .toc-list {
-    list-style: none;
-    padding-left: 0;
-    margin: 0;
-  }
-  
-  .toc-item {
-    margin-bottom: 0.25rem;
-    line-height: 1.4;
-  }
-  
-  .toc-link {
-      text-decoration: none;
-      color: var(--link-color);
-      display: inline-block;
-      padding: 0.1rem 0;
-      font-size: 0.9rem;
-      font-weight: 500;
-  
-  }
-  
-  .toc-link:hover {
-    text-decoration: underline;
-  }
-  
-  /* Indentation for different heading levels */
-  .toc-level-2 {
-    margin-left: 0;
-  }
-  
-  .toc-level-3 {
-    margin-left: 0.75rem;
-    font-size: 0.85rem;
-  }
-  
-  .toc-level-4 {
-    margin-left: 1.5rem;
-    font-size: 0.8rem;
-  }
-  
-  /* TOC sidebar should only display on active pages */
-  .toc-sidebar {
-      width: 180px;
-      position: sticky;
-      top: 2rem;
-      max-height: calc(100vh - 4rem);
-      overflow-y: auto;
-      align-self: flex-start;
-  
-  }
-  
-  /* Hide TOC on mobile */
-  @media (max-width: 1024px) {
-    .toc-sidebar {
-      width: 100%;
-      position: static;
-      margin-bottom: 1rem;
-    }
-  }