@mgks/docmd 0.1.0 → 0.1.1

package/src/assets/css/{main.css → docmd-main.css}

@@ -1,6 +1,4 @@
-/* src/assets/css/main.css */
-@import url('./toc.css'); /* Import the TOC styles */
-
+/* src/assets/css/docmd-main.css */
 :root {
     --font-family-sans: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
     --font-family-mono: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
@@ -18,6 +16,14 @@
     --code-text: #333;
     --header-bg: #ffffff; /* Added for header */
     --header-border: #e0e0e0; /* Added for header border */
+    
+    /* Image styling variables */
+    --image-border-color: #e0e0e0;
+    --image-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
+    --image-caption-bg: #f8f8f8;
+    --image-caption-text: #666;
+    --lightbox-bg: rgba(0, 0, 0, 0.9);
+    --lightbox-text: #fff;
   }
   
   body[data-theme="dark"] {
@@ -33,6 +39,14 @@
     --code-text: #abb2bf;
     --header-bg: #1a1a1a; /* Added for header */
     --header-border: #444444; /* Added for header border */
+    
+    /* Image styling variables for dark mode */
+    --image-border-color: #444444;
+    --image-shadow: 0 2px 8px rgba(0, 0, 0, 0.3);
+    --image-caption-bg: #2c2c2c;
+    --image-caption-text: #bdc3c7;
+    --lightbox-bg: rgba(0, 0, 0, 0.95);
+    --lightbox-text: #fff;
   }
   
   body {
@@ -275,11 +289,6 @@
   .callout .callout-content > :first-child { margin-top: 0; }
   .callout .callout-content > :last-child { margin-bottom: 0; }
 
-
-  /* Cards */
-  .card {
-    /* background-color: var(--code-bg); /* Already set by .docmd-container */
-  }
   .card .card-title {
     font-weight: bold;
     font-size: 1.1em;
@@ -559,4 +568,238 @@
       display: flex;
       flex-direction: column-reverse;
     }
-  }
+  }
+
+  /* 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;
+  }
+}
+
+/* Basic image styling */
+img {
+  max-width: 100%;
+  height: auto;
+  display: block;
+  margin: 1.5rem 0;
+}
+
+/* Image alignment classes */
+img.align-left {
+  float: left;
+  margin-right: 1.5rem;
+  margin-bottom: 1rem;
+}
+
+img.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+img.align-right {
+  float: right;
+  margin-left: 1.5rem;
+  margin-bottom: 1rem;
+}
+
+/* Image size classes */
+img.size-small {
+  max-width: 300px;
+}
+
+img.size-medium {
+  max-width: 500px;
+}
+
+img.size-large {
+  max-width: 800px;
+}
+
+/* Image borders and shadows */
+img.with-border {
+  border: 1px solid var(--image-border-color);
+  padding: 4px;
+}
+
+img.with-shadow {
+  box-shadow: var(--image-shadow);
+}
+
+/* Figure and caption styling */
+.docmd-container figure {
+  margin: 2rem 0;
+}
+
+.docmd-container figure img {
+  margin-bottom: 0.5rem;
+}
+
+.docmd-container figcaption {
+  font-size: 0.9rem;
+  color: var(--image-caption-text);
+  text-align: center;
+  padding: 0.5rem;
+  background-color: var(--image-caption-bg);
+  border-radius: 0 0 4px 4px;
+}
+
+/* Image gallery */
+.docmd-container .image-gallery {
+  display: grid;
+  grid-template-columns: repeat(auto-fill, minmax(250px, 1fr));
+  gap: 1rem;
+  margin: 2rem 0;
+}
+
+.docmd-container .image-gallery figure {
+  margin: 0;
+}
+
+/* Clear floats after aligned images */
+.docmd-container .clear-float::after {
+  content: "";
+  display: table;
+  clear: both;
+}
+
+/* Lightbox styling */
+.docmd-lightbox {
+  display: none;
+  position: fixed;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  background-color: var(--lightbox-bg);
+  z-index: 9999;
+  justify-content: center;
+  align-items: center;
+  flex-direction: column;
+}
+
+.docmd-lightbox-content {
+  position: relative;
+  max-width: 90%;
+  max-height: 90%;
+  text-align: center;
+}
+
+.docmd-lightbox-content img {
+  max-width: 100%;
+  max-height: 80vh;
+  object-fit: contain;
+  margin: 0 auto;
+  box-shadow: 0 0 20px rgba(0, 0, 0, 0.3);
+}
+
+.docmd-lightbox-caption {
+  color: var(--lightbox-text);
+  padding: 1rem;
+  font-size: 1rem;
+  max-width: 100%;
+}
+
+.docmd-lightbox-close {
+  position: absolute;
+  top: 20px;
+  right: 30px;
+  color: var(--lightbox-text);
+  font-size: 2.5rem;
+  cursor: pointer;
+  z-index: 10000;
+}
+
+.docmd-lightbox-close:hover {
+  color: #ddd;
+}
+
+/* Cursor for lightbox images */
+img.lightbox,
+.docmd-container .image-gallery img {
+  cursor: zoom-in;
+}
+
+/* Responsive image handling */
+@media (max-width: 768px) {
+  img.align-left,
+  img.align-right {
+    float: none;
+    margin-left: auto;
+    margin-right: auto;
+  }
+  
+  .docmd-container .image-gallery {
+    grid-template-columns: 1fr;
+  }
+} 

package/src/assets/css/{theme-sky.css → docmd-theme-sky.css}

@@ -1,4 +1,4 @@
-/* theme-sky.css - Sky theme for docmd inspired by Mintlify */
+/* theme-sky.css - Sky theme for docmd */
 
 :root [data-theme="light"] {
     /* Font family */
@@ -35,6 +35,16 @@
     --shadow-sm: 0 1px 2px 0 rgba(0, 0, 0, 0.05);
     --shadow-md: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
     --shadow-lg: 0 10px 15px -3px rgba(0, 0, 0, 0.1), 0 4px 6px -2px rgba(0, 0, 0, 0.05);
+    
+    /* Image styling variables */
+    --image-border-color: var(--sky-border);
+    --image-shadow: var(--shadow-md);
+    --image-caption-bg: var(--sky-background-alt);
+    --image-caption-text: var(--sky-text-light);
+    --image-hover-transform: translateY(-2px);
+    --image-hover-shadow: var(--shadow-lg);
+    --image-border-radius: 8px;
+    --image-transition: all 0.3s ease;
   }
   
   /* Dark mode */
@@ -69,6 +79,16 @@
     --shadow-sm: 0 1px 2px 0 rgba(0, 0, 0, 0.3);
     --shadow-md: 0 4px 6px -1px rgba(0, 0, 0, 0.3), 0 2px 4px -1px rgba(0, 0, 0, 0.2);
     --shadow-lg: 0 10px 15px -3px rgba(0, 0, 0, 0.3), 0 4px 6px -2px rgba(0, 0, 0, 0.2);
+    
+    /* Image styling variables for dark mode */
+    --image-border-color: var(--sky-border);
+    --image-shadow: 0 4px 8px rgba(0, 0, 0, 0.5);
+    --image-caption-bg: var(--sky-background-alt);
+    --image-caption-text: var(--sky-text-light);
+    --image-hover-transform: translateY(-2px);
+    --image-hover-shadow: 0 6px 12px rgba(0, 0, 0, 0.7);
+    --image-border-radius: 8px;
+    --image-transition: all 0.3s ease;
   }
   
   /* Apply theme styles */
@@ -496,4 +516,136 @@
     h3 {
       font-size: 1.25rem;
     }
+  }  
+
+  /* Enhanced image styling for Sky theme */
+  img {
+    border-radius: var(--image-border-radius);
+    transition: var(--image-transition);
+  }
+
+  /* Enhanced borders and shadows */
+  img.with-border {
+    border: 1px solid var(--image-border-color);
+    padding: 8px;
+    background-color: var(--bg-color);
+  }
+
+  img.with-shadow {
+    box-shadow: var(--image-shadow);
+  }
+
+  img.with-shadow:hover {
+    box-shadow: var(--image-hover-shadow);
+  }
+
+  /* Beautiful figure styling */
+  figure {
+    border-radius: var(--image-border-radius);
+    overflow: hidden;
+    transition: var(--image-transition);
+    box-shadow: var(--shadow-sm);
+  }
+
+  figure:hover {
+    box-shadow: var(--shadow-md);
+  }
+
+  figure img {
+    margin-bottom: 0;
+    border-radius: var(--image-border-radius) var(--image-border-radius) 0 0;
+  }
+
+  figcaption {
+    background-color: var(--image-caption-bg);
+    color: var(--image-caption-text);
+    padding: 0.75rem 1rem;
+    font-size: 0.9rem;
+    font-weight: 500;
+  }
+
+  /* Advanced image gallery */
+  .image-gallery {
+    display: grid;
+    grid-template-columns: repeat(auto-fill, minmax(280px, 1fr));
+    gap: 1.5rem;
+    margin: 2rem 0;
+  }
+
+  .image-gallery figure {
+    height: 100%;
+    display: flex;
+    flex-direction: column;
+    margin: 0;
+    transition: var(--image-transition);
+  }
+
+  .image-gallery figure:hover {
+    transform: var(--image-hover-transform);
+  }
+
+  .image-gallery img {
+    height: 200px;
+    width: 100%;
+    object-fit: cover;
+    margin: 0;
+  }
+
+  .image-gallery figcaption {
+    flex: 1;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    text-align: center;
+  }
+
+  /* Zoom effect on gallery images */
+  .image-gallery.zoom img {
+    transition: transform 0.5s ease;
+  }
+
+  .image-gallery.zoom figure:hover img {
+    transform: scale(1.05);
+  }
+
+  /* Lightbox effect - requires JavaScript implementation */
+  img.lightbox {
+    cursor: zoom-in;
+  }
+
+  /* Image with frames */
+  img.framed {
+    border: 8px solid white;
+    box-shadow: 0 0 0 1px var(--image-border-color), var(--image-shadow);
+    box-sizing: border-box;
+  }
+
+  /* Polaroid style */
+  figure.polaroid {
+    background: white;
+    padding: 10px 10px 30px 10px;
+    box-shadow: var(--shadow-md);
+  }
+
+  figure.polaroid img {
+    border-radius: 0;
+    box-shadow: none;
+  }
+
+  figure.polaroid figcaption {
+    background: white;
+    color: var(--sky-text);
+    font-family: 'Caveat', cursive, var(--font-family-sans);
+    font-size: 1.1rem;
+  }
+
+  /* Responsive adjustments */
+  @media (max-width: 768px) {
+    .image-gallery {
+      grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
+    }
+    
+    .image-gallery img {
+      height: 150px;
+    }
   }  

package/src/assets/js/docmd-image-lightbox.js

@@ -0,0 +1,72 @@
+/**
+ * docmd-image-lightbox.js - Simple lightbox implementation for docmd images
+ */
+
+document.addEventListener('DOMContentLoaded', function() {
+  // Create lightbox elements
+  const lightbox = document.createElement('div');
+  lightbox.className = 'docmd-lightbox';
+  lightbox.innerHTML = `
+    <div class="docmd-lightbox-content">
+      <img src="" alt="">
+      <div class="docmd-lightbox-caption"></div>
+    </div>
+    <div class="docmd-lightbox-close">&times;</div>
+  `;
+  document.body.appendChild(lightbox);
+
+  const lightboxImg = lightbox.querySelector('img');
+  const lightboxCaption = lightbox.querySelector('.docmd-lightbox-caption');
+  const lightboxClose = lightbox.querySelector('.docmd-lightbox-close');
+
+  // Find all images with lightbox class or in image galleries
+  const lightboxImages = document.querySelectorAll('img.lightbox, .image-gallery img');
+  
+  // Add click event to each image
+  lightboxImages.forEach(function(img) {
+    img.style.cursor = 'zoom-in';
+    
+    img.addEventListener('click', function() {
+      // Get the image source and caption
+      const src = this.getAttribute('src');
+      let caption = this.getAttribute('alt') || '';
+      
+      // If image is inside a figure with figcaption, use that caption
+      const figure = this.closest('figure');
+      if (figure) {
+        const figcaption = figure.querySelector('figcaption');
+        if (figcaption) {
+          caption = figcaption.textContent;
+        }
+      }
+      
+      // Set the lightbox content
+      lightboxImg.setAttribute('src', src);
+      lightboxCaption.textContent = caption;
+      
+      // Show the lightbox
+      lightbox.style.display = 'flex';
+      document.body.style.overflow = 'hidden'; // Prevent scrolling
+    });
+  });
+  
+  // Close lightbox when clicking the close button or outside the image
+  lightboxClose.addEventListener('click', closeLightbox);
+  lightbox.addEventListener('click', function(e) {
+    if (e.target === lightbox) {
+      closeLightbox();
+    }
+  });
+  
+  // Close lightbox when pressing Escape key
+  document.addEventListener('keydown', function(e) {
+    if (e.key === 'Escape' && lightbox.style.display === 'flex') {
+      closeLightbox();
+    }
+  });
+  
+  function closeLightbox() {
+    lightbox.style.display = 'none';
+    document.body.style.overflow = ''; // Restore scrolling
+  }
+}); 

package/src/assets/js/{theme-toggle.js → docmd-theme-toggle.js}

@@ -12,10 +12,10 @@ function applyTheme(theme, isInitialLoad = false) {
     const isLight = theme.includes('light');
     const currentHref = highlightThemeLink.href;
     
-    if (isDark && currentHref.includes('highlight-light.css')) {
-      highlightThemeLink.href = currentHref.replace('highlight-light.css', 'highlight-dark.css');
-    } else if (isLight && currentHref.includes('highlight-dark.css')) {
-      highlightThemeLink.href = currentHref.replace('highlight-dark.css', 'highlight-light.css');
+    if (isDark && currentHref.includes('docmd-highlight-light.css')) {
+      highlightThemeLink.href = currentHref.replace('docmd-highlight-light.css', 'docmd-highlight-dark.css');
+    } else if (isLight && currentHref.includes('docmd-highlight-dark.css')) {
+      highlightThemeLink.href = currentHref.replace('docmd-highlight-dark.css', 'docmd-highlight-light.css');
     }
   }
 }

package/src/commands/build.js

@@ -6,6 +6,7 @@ const { processMarkdownFile } = require('../core/file-processor');
 const { generateHtmlPage, generateNavigationHtml } = require('../core/html-generator');
 const { renderIcon, clearWarnedIcons } = require('../core/icon-renderer'); // Update import
 const { generateSitemap } = require('../plugins/sitemap'); // Import our sitemap plugin
+const { version } = require('../../package.json'); // Import package version
 
 // Debug function to log navigation information
 function logNavigationPaths(pagePath, navPath, normalizedPath) {
@@ -17,7 +18,17 @@ function logNavigationPaths(pagePath, navPath, normalizedPath) {
 // Add a global or scoped flag to track if the warning has been shown in the current dev session
 let highlightWarningShown = false;
 
-async function buildSite(configPath, options = { isDev: false }) {
+// Asset version metadata - update this when making significant changes to assets
+const ASSET_VERSIONS = {
+  'css/docmd-main.css': { version: version, description: 'Core styles' },
+  'css/docmd-theme-sky.css': { version: version, description: 'Sky theme' },
+  'css/docmd-highlight-light.css': { version: version, description: 'Light syntax highlighting' },
+  'css/docmd-highlight-dark.css': { version: version, description: 'Dark syntax highlighting' },
+  'js/docmd-theme-toggle.js': { version: version, description: 'Theme toggle functionality' },
+  // Add other assets here with their versions
+};
+
+async function buildSite(configPath, options = { isDev: false, preserve: false }) {
   clearWarnedIcons(); // Clear warnings at the start of every build
 
   const config = await loadConfig(configPath);
@@ -29,25 +40,66 @@ async function buildSite(configPath, options = { isDev: false }) {
     throw new Error(`Source directory not found: ${SRC_DIR}`);
   }
 
-  await fs.emptyDir(OUTPUT_DIR);
-  if (!options.isDev) {
-    console.log(`🧹 Cleaned output directory: ${OUTPUT_DIR}`);
+  // Create output directory if it doesn't exist
+  await fs.ensureDir(OUTPUT_DIR);
+
+  // Instead of emptying the entire directory, we'll selectively clean up HTML files
+  // This preserves custom assets while ensuring we don't have stale HTML files
+  if (await fs.pathExists(OUTPUT_DIR)) {
+    const cleanupFiles = await findFilesToCleanup(OUTPUT_DIR);
+    for (const file of cleanupFiles) {
+      await fs.remove(file);
+    }
+    if (!options.isDev) {
+      console.log(`🧹 Cleaned HTML files from output directory: ${OUTPUT_DIR}`);
+    }
   }
 
+  // Track preserved files for summary report
+  const preservedFiles = [];
+
+  // Copy assets
   const assetsSrcDir = path.join(__dirname, '..', 'assets');
   const assetsDestDir = path.join(OUTPUT_DIR, 'assets');
+  
   if (await fs.pathExists(assetsSrcDir)) {
-    await fs.copy(assetsSrcDir, assetsDestDir);
     if (!options.isDev) {
-        console.log(`📂 Copied assets to ${assetsDestDir}`);
+      console.log(`📂 Copying assets to ${assetsDestDir}...`);
+    }
+    
+    // Create destination directory if it doesn't exist
+    await fs.ensureDir(assetsDestDir);
+    
+    // Get all files from source directory recursively
+    const assetFiles = await getAllFiles(assetsSrcDir);
+    
+    // Copy each file individually, checking for existing files if preserve flag is set
+    for (const srcFile of assetFiles) {
+      const relativePath = path.relative(assetsSrcDir, srcFile);
+      const destFile = path.join(assetsDestDir, relativePath);
+      
+      // Check if destination file already exists
+      const fileExists = await fs.pathExists(destFile);
+      
+      if (fileExists && options.preserve) {
+        // Skip file and add to preserved list
+        preservedFiles.push(relativePath);
+        if (!options.isDev) {
+          console.log(`  Preserving existing file: ${relativePath}`);
+        }
+      } else {
+        // Copy file (either it doesn't exist or we're not preserving)
+        await fs.ensureDir(path.dirname(destFile));
+        await fs.copyFile(srcFile, destFile);
+      }
     }
   } else {
     console.warn(`⚠️  Assets source directory not found: ${assetsSrcDir}`);
   }
 
   // Check for Highlight.js themes
-  const lightThemePath = path.join(__dirname, '..', 'assets', 'css', 'highlight-light.css');
-  const darkThemePath = path.join(__dirname, '..', 'assets', 'css', 'highlight-dark.css');
+  const lightThemePath = path.join(__dirname, '..', 'assets', 'css', 'docmd-highlight-light.css');
+  const darkThemePath = path.join(__dirname, '..', 'assets', 'css', 'docmd-highlight-dark.css');
 
   const themesMissing = !await fs.pathExists(lightThemePath) || !await fs.pathExists(darkThemePath);
 
@@ -280,6 +332,55 @@ async function buildSite(configPath, options = { isDev: false }) {
       console.error(`❌ Error generating sitemap: ${error.message}`);
     }
   }
+
+  // Print summary of preserved files at the end of build
+  if (preservedFiles.length > 0 && !options.isDev) {
+    console.log(`\n📋 Build Summary: ${preservedFiles.length} existing files were preserved:`);
+    preservedFiles.forEach(file => console.log(`  - assets/${file}`));
+    console.log(`\nTo update these files in future builds, run without the --preserve flag.`);
+  }
+}
+
+// Helper function to find HTML files and sitemap.xml to clean up
+async function findFilesToCleanup(dir) {
+  const filesToRemove = [];
+  const items = await fs.readdir(dir, { withFileTypes: true });
+  
+  for (const item of items) {
+    const fullPath = path.join(dir, item.name);
+    
+    if (item.isDirectory()) {
+      // Don't delete the assets directory
+      if (item.name !== 'assets') {
+        const subDirFiles = await findFilesToCleanup(fullPath);
+        filesToRemove.push(...subDirFiles);
+      }
+    } else if (
+      item.name.endsWith('.html') || 
+      item.name === 'sitemap.xml'
+    ) {
+      filesToRemove.push(fullPath);
+    }
+  }
+  
+  return filesToRemove;
+}
+
+// Helper function to recursively get all files in a directory
+async function getAllFiles(dir) {
+  const files = [];
+  const items = await fs.readdir(dir, { withFileTypes: true });
+  
+  for (const item of items) {
+    const fullPath = path.join(dir, item.name);
+    if (item.isDirectory()) {
+      files.push(...await getAllFiles(fullPath));
+    } else {
+      files.push(fullPath);
+    }
+  }
+  
+  return files;
 }
 
 // findMarkdownFiles function remains the same