@mgks/docmd 0.3.11 → 0.4.1

package/src/commands/init.js

@@ -1,277 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-
-const fs = require('../core/fs-utils');
-const path = require('path');
-const readline = require('readline');
-const { version } = require('../../package.json');
-
-const defaultConfigContent = `// docmd.config.js
-module.exports = {
-  // --- Core Metadata ---
-  siteTitle: 'My Documentation',
-  siteUrl: '', // e.g. https://mysite.com (Critical for SEO/Sitemap)
-
-  // --- Branding ---
-  logo: {
-    light: 'assets/images/docmd-logo-dark.png',
-    dark: 'assets/images/docmd-logo-light.png',
-    alt: 'Logo',
-    href: './',
-  },
-  favicon: 'assets/favicon.ico',
-
-  // --- Source & Output ---
-  srcDir: 'docs',
-  outputDir: 'site',
-
-  // --- Theme & Layout ---
-  theme: {
-    name: 'sky',            // Options: 'default', 'sky', 'ruby', 'retro'
-    defaultMode: 'system',  // 'light', 'dark', or 'system'
-    enableModeToggle: true, // Show mode toggle button
-    positionMode: 'top',    // 'top' or 'bottom'
-    codeHighlight: true,    // Enable Highlight.js
-    customCss: [],          // e.g. ['assets/css/custom.css']
-  },
-
-  // --- Features ---
-  search: true,           // Built-in offline search
-  minify: true,           // Minify HTML/CSS/JS in build
-  autoTitleFromH1: true,  // Auto-generate page title from first H1
-  copyCode: true,         // Show "copy" button on code blocks
-  pageNavigation: true,   // Prev/Next buttons at bottom
-
-  // --- Navigation (Sidebar) ---
-  navigation: [
-    { title: 'Introduction', path: '/', icon: 'home' },
-    {
-      title: 'Guide',
-      icon: 'book-open',
-      collapsible: true,
-      children: [
-        { title: 'Getting Started', path: 'https://docs.docmd.io/getting-started/installation', icon: 'rocket', external: true },
-        { title: 'Configuration', path: 'https://docs.docmd.io/configuration', icon: 'settings', external: true },
-      ],
-    },
-    { title: 'Live Editor', path: 'https://live.docmd.io', icon: 'pencil-ruler', external: true },
-    { title: 'GitHub', path: 'https://github.com/docmd-io/docmd', icon: 'github', external: true },
-  ],
-
-  // --- Plugins ---
-  plugins: {
-    seo: {
-      defaultDescription: 'Documentation built with docmd.',
-      openGraph: {
-        defaultImage: '',   // e.g. 'assets/images/og-image.png'
-      },
-      twitter: {
-        cardType: 'summary_large_image',
-      }
-    },
-    analytics: {
-      googleV4: {
-        measurementId: 'G-X9WTDL262N' // Replace with your Google Analytics Measurement ID
-      }
-    },
-    sitemap: {
-      defaultChangefreq: 'weekly',  // e.g. 'daily', 'weekly', 'monthly'
-      defaultPriority: 0.8          // Priority between 0.0 and 1.0
-    }
-  },
-
-  // --- Footer ---
-  footer: '© ' + new Date().getFullYear() + ' My Project. Built with [docmd](https://docmd.io).',
-  
-  // --- Edit Link ---
-  editLink: {
-    enabled: false,
-    baseUrl: 'https://github.com/USERNAME/REPO/edit/main/docs',
-    text: 'Edit this page'
-  }
-};
-`;
-
-const defaultIndexMdContent = `---
-title: "Welcome"
-description: "Welcome to your new documentation site."
----
-
-# Welcome to Your Docs
-
-Congratulations! You have successfully initialized a new **docmd** project.
-
-## 🚀 Quick Start
-
-You are currently viewing the content of \`docs/index.md\`.
-
-\`\`\`bash
-npm start   # Start the dev server
-docmd build # Build for production
-\`\`\`
-
-## ✨ Features Demo
-
-docmd comes with built-in components to make your documentation beautiful.
-
-::: callout tip
-**Try this:** Edit this file and save it. The browser will live reload instantly!
-:::
-
-### Container Examples
-
-::: card Flexible Structure
-**Organize your way.**
-Create Markdown files in the \`docs/\` folder and map them in \`docmd.config.js\`.
-:::
-
-::: tabs
-== tab "Simple"
-This is a simple tab content.
-
-== tab "Nested"
-::: callout info
-You can even nest other components inside tabs!
-:::
-:::
-
-## 📚 Next Steps
-
-*   [Check the Official Documentation](https://docs.docmd.io)
-*   [Customize your Theme](https://docs.docmd.io/theming)
-*   [Deploy to GitHub Pages](https://docs.docmd.io/deployment)
-`;
-
-const defaultPackageJson = {
-  name: "my-docs",
-  version: "0.0.1",
-  private: true,
-  scripts: {
-    "dev": "docmd dev",
-    "build": "docmd build",
-    "preview": "npx serve site"
-  },
-  dependencies: {
-    "@mgks/docmd": `^${version}`
-  }
-};
-
-async function initProject() {
-  const baseDir = process.cwd();
-  const packageJsonFile = path.join(baseDir, 'package.json');
-  const configFile = path.join(baseDir, 'docmd.config.js');
-  const docsDir = path.join(baseDir, 'docs');
-  const indexMdFile = path.join(docsDir, 'index.md');
-  const assetsDir = path.join(baseDir, 'assets');
-  const assetsCssDir = path.join(assetsDir, 'css');
-  const assetsJsDir = path.join(assetsDir, 'js');
-  const assetsImagesDir = path.join(assetsDir, 'images');
-  
-  const existingFiles = [];
-  const dirExists = {
-    docs: false,
-    assets: false
-  };
-  
-  // Check if package.json exists
-  if (!await fs.pathExists(packageJsonFile)) {
-    await fs.writeJson(packageJsonFile, defaultPackageJson, { spaces: 2 });
-    console.log('📦 Created `package.json` (Deployment Ready)');
-  } else {
-    console.log('⏭️  Skipped existing `package.json`');
-  }
-
-  // Check each file individually
-  if (await fs.pathExists(configFile)) {
-    existingFiles.push('docmd.config.js');
-  }
-
-  // Check for the legacy config.js
-  const oldConfigFile = path.join(baseDir, 'config.js');
-  if (await fs.pathExists(oldConfigFile)) {
-    existingFiles.push('config.js');
-  }
-  
-  // Check if docs directory exists
-  if (await fs.pathExists(docsDir)) {
-    dirExists.docs = true;
-    if (await fs.pathExists(indexMdFile)) {
-      existingFiles.push('docs/index.md');
-    }
-  }
-
-  // Check if assets directory exists
-  if (await fs.pathExists(assetsDir)) {
-    dirExists.assets = true;
-  }
-  
-  // Determine if we should override existing files
-  let shouldOverride = false;
-  if (existingFiles.length > 0) {
-    console.warn('⚠️  The following files already exist:');
-    existingFiles.forEach(file => console.warn(`   - ${file}`));
-    
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout
-    });
-    
-    const answer = await new Promise(resolve => {
-      rl.question('Do you want to override these files? (y/N): ', resolve);
-    });
-    
-    rl.close();
-    
-    shouldOverride = answer.toLowerCase() === 'y';
-    
-    if (!shouldOverride) {
-      console.log('⏭️  Skipping existing files. Will only create new files.');
-    }
-  }
-  
-  // Create docs directory if it doesn't exist
-  if (!dirExists.docs) {
-    await fs.ensureDir(docsDir);
-    console.log('📁 Created `docs/` directory');
-  } else {
-    console.log('📁 Using existing `docs/` directory');
-  }
-
-  // Create assets directory structure if it doesn't exist
-  if (!dirExists.assets) {
-    await fs.ensureDir(assetsDir);
-    await fs.ensureDir(assetsCssDir);
-    await fs.ensureDir(assetsJsDir);
-    await fs.ensureDir(assetsImagesDir);
-    console.log('📁 Created `assets/` directory with css, js, and images subdirectories');
-  } else {
-    console.log('📁 Using existing `assets/` directory');
-    
-    if (!await fs.pathExists(assetsCssDir)) await fs.ensureDir(assetsCssDir);
-    if (!await fs.pathExists(assetsJsDir)) await fs.ensureDir(assetsJsDir);
-    if (!await fs.pathExists(assetsImagesDir)) await fs.ensureDir(assetsImagesDir);
-  }
-  
-  // Write config file if it doesn't exist or user confirmed override
-  if (!await fs.pathExists(configFile) || shouldOverride) {
-    await fs.writeFile(configFile, defaultConfigContent, 'utf8');
-    console.log(`📄 ${shouldOverride ? 'Updated' : 'Created'} \`docmd.config.js\``);
-  } else {
-    console.log('⏭️  Skipped existing `docmd.config.js`');
-  }
-  
-  // Write index.md file if it doesn't exist or user confirmed override
-  if (!await fs.pathExists(indexMdFile) || shouldOverride) {
-    await fs.writeFile(indexMdFile, defaultIndexMdContent, 'utf8');
-    console.log('📄 Created `docs/index.md`');
-  } else if (shouldOverride) {
-    await fs.writeFile(indexMdFile, defaultIndexMdContent, 'utf8');
-    console.log('📄 Updated `docs/index.md`');
-  } else {
-    console.log('⏭️  Skipped existing `docs/index.md`');
-  }
-  
-  console.log('✅ Project initialization complete!');
-  console.log('👉 Run `npm install` to setup dependencies.');
-}
-
-module.exports = { initProject };

package/src/commands/live.js

@@ -1,145 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-
-const fs = require('../core/fs-utils'); // Native wrapper
-const path = require('path');
-const esbuild = require('esbuild');
-const { processAssets } = require('../core/asset-manager');
-
-async function build() {
-    console.log('📦 Building @docmd/live core...');
-
-    // Resolve paths relative to src/commands/live.js
-    const SRC_DIR = path.resolve(__dirname, '..'); // Points to /src
-    const LIVE_SRC_DIR = path.join(SRC_DIR, 'live');
-    const DIST_DIR = path.resolve(__dirname, '../../dist'); // Points to /dist in root
-
-    // 1. Clean/Create dist
-    if (await fs.exists(DIST_DIR)) {
-        await fs.remove(DIST_DIR);
-    }
-    await fs.ensureDir(DIST_DIR);
-
-    // 2. Generate Shim for Buffer (Browser compatibility)
-    const shimPath = path.join(LIVE_SRC_DIR, 'shims.js');
-    await fs.writeFile(shimPath, `import { Buffer } from 'buffer'; globalThis.Buffer = Buffer;`);
-
-    // 3. Define the Virtual Template Plugin
-    // This reads EJS files from disk and bundles them as a JSON object string
-    const templatePlugin = {
-        name: 'docmd-templates',
-        setup(build) {
-            build.onResolve({ filter: /^virtual:docmd-templates$/ }, args => ({
-                path: args.path,
-                namespace: 'docmd-templates-ns',
-            }));
-
-            build.onLoad({ filter: /.*/, namespace: 'docmd-templates-ns' }, async () => {
-                const templatesDir = path.join(SRC_DIR, 'templates');
-                const files = await fs.readdir(templatesDir);
-                const templates = {};
-
-                for (const file of files) {
-                    if (file.endsWith('.ejs')) {
-                        const content = await fs.readFile(path.join(templatesDir, file), 'utf8');
-                        templates[file] = content;
-                    }
-                }
-
-                return {
-                    contents: `module.exports = ${JSON.stringify(templates)};`,
-                    loader: 'js',
-                };
-            });
-        },
-    };
-
-    // 4. Define Node Modules Shim Plugin
-    // Stubs out fs/path requires so the browser bundle doesn't crash
-    const nodeShimPlugin = {
-        name: 'node-deps-shim',
-        setup(build) {
-            build.onResolve({ filter: /^(node:)?path$/ }, args => ({ path: args.path, namespace: 'path-shim' }));
-            build.onLoad({ filter: /.*/, namespace: 'path-shim' }, () => ({
-                contents: `
-                    module.exports = {
-                        join: (...args) => args.filter(Boolean).join('/'),
-                        resolve: (...args) => '/' + args.filter(Boolean).join('/'),
-                        basename: (p) => p ? p.split(/[\\\\/]/).pop() : '',
-                        dirname: (p) => p ? p.split(/[\\\\/]/).slice(0, -1).join('/') || '.' : '.',
-                        extname: (p) => { if (!p) return ''; const parts = p.split('.'); return parts.length > 1 ? '.' + parts.pop() : ''; },
-                        isAbsolute: (p) => p.startsWith('/'),
-                        normalize: (p) => p,
-                        sep: '/'
-                    };
-                `,
-                loader: 'js'
-            }));
-
-            build.onResolve({ filter: /^(node:)?fs(\/promises)?|fs-extra$/ }, args => ({ path: args.path, namespace: 'fs-shim' }));
-            build.onLoad({ filter: /.*/, namespace: 'fs-shim' }, () => ({
-                contents: `
-                    module.exports = {
-                        existsSync: () => false,
-                        readFileSync: () => '',
-                        statSync: () => ({ isFile: () => true, isDirectory: () => false }),
-                        constants: { F_OK: 0, R_OK: 4 },
-                        promises: {}
-                    };
-                `, 
-                loader: 'js'
-            }));
-        }
-    };
-
-    // 5. Bundle JS
-    console.log('⚡ Bundling & Compressing JS...');
-    try {
-        await esbuild.build({
-            entryPoints: [path.join(LIVE_SRC_DIR, 'core.js')],
-            bundle: true,
-            outfile: path.join(DIST_DIR, 'docmd-live.js'),
-            platform: 'browser',
-            format: 'iife',
-            globalName: 'docmd',
-            minify: true,
-            define: { 'process.env.NODE_ENV': '"production"' },
-            inject: [shimPath],
-            plugins: [templatePlugin, nodeShimPlugin]
-        });
-
-        // 6. Copy & Minify Static Assets using Universal Manager
-        console.log('📂 Processing static assets...');
-        const assetsSrc = path.join(SRC_DIR, 'assets');
-        const assetsDest = path.join(DIST_DIR, 'assets');
-        
-        if (await fs.exists(assetsSrc)) {
-            await processAssets(assetsSrc, assetsDest, { minify: true });
-        }
-
-        // 7. Copy HTML Wrapper & Minify Live CSS
-        await fs.copy(path.join(LIVE_SRC_DIR, 'index.html'), path.join(DIST_DIR, 'index.html'));
-        
-        const liveCss = await fs.readFile(path.join(LIVE_SRC_DIR, 'live.css'), 'utf8');
-        const minifiedLiveCss = await esbuild.transform(liveCss, { loader: 'css', minify: true });
-        await fs.writeFile(path.join(DIST_DIR, 'live.css'), minifiedLiveCss.code);
-
-        // 8. Copy Favicon to Root
-        const internalFavicon = path.join(assetsSrc, 'favicon.ico');
-        if (await fs.exists(internalFavicon)) {
-            await fs.copy(internalFavicon, path.join(DIST_DIR, 'favicon.ico'));
-        }
-
-        console.log('✅ Live Editor build complete!');
-
-    } catch (e) {
-        console.error('❌ Build failed:', e);
-        process.exit(1);
-    }
-}
-
-// Allow direct execution (via scripts/failsafe.js)
-if (require.main === module) {
-    build();
-}
-
-module.exports = { build };

package/src/core/asset-manager.js

@@ -1,72 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-
-const path = require('path');
-const fs = require('./fs-utils');
-const esbuild = require('esbuild');
-
-const DOCMD_HEADER = `/*! Source file from the docmd project — https://github.com/docmd-io/docmd */\n\n`;
-
-/**
- * Recursively copies assets from src to dest.
- * Minifies CSS/JS files and adds docmd header.
- * 
- * @param {string} srcDir - Source directory
- * @param {string} destDir - Destination directory
- * @param {object} options - { minify: boolean }
- */
-async function processAssets(srcDir, destDir, options = { minify: true }) {
-  // Ensure source exists
-  if (!await fs.exists(srcDir)) return;
-
-  // Ensure dest exists
-  await fs.ensureDir(destDir);
-
-  const entries = await fs.readdir(srcDir, { withFileTypes: true });
-
-  for (const entry of entries) {
-    const srcPath = path.join(srcDir, entry.name);
-    const destPath = path.join(destDir, entry.name);
-
-    if (entry.isDirectory()) {
-      await processAssets(srcPath, destPath, options);
-    } else {
-      const ext = path.extname(entry.name).toLowerCase();
-      
-      // Handle CSS & JS: Minify + docmd Header
-      if (ext === '.css' || ext === '.js') {
-        try {
-          const content = await fs.readFile(srcPath, 'utf8');
-          
-          if (options.minify) {
-            // Minify using esbuild
-            const result = await esbuild.transform(content, {
-              loader: ext.slice(1), // 'css' or 'js'
-              minify: true,
-              banner: ext === '.css' || ext === '.js' ? DOCMD_HEADER : ''
-            });
-            await fs.writeFile(destPath, result.code);
-          } else {
-            // Just add banner if not minifying (Dev mode)
-            const contentWithBanner = `${DOCMD_HEADER}\n${content}`;
-            await fs.writeFile(destPath, contentWithBanner);
-          }
-        } catch (e) {
-          console.warn(`⚠️ Processing failed for ${entry.name}, copying original.`);
-          await fs.copy(srcPath, destPath);
-        }
-      } 
-      // Handle HTML Files (if any in assets): HTML Comment Header
-      else if (ext === '.html') {
-        const content = await fs.readFile(srcPath, 'utf8');
-        const htmlBanner = `<!-- Generated by docmd - https://docmd.io -->\n\n`;
-        await fs.writeFile(destPath, htmlBanner + content);
-      }
-      // Everything else (Images, Fonts): Direct Copy
-      else {
-        await fs.copy(srcPath, destPath);
-      }
-    }
-  }
-}
-
-module.exports = { processAssets, DOCMD_HEADER };

package/src/core/config-loader.js

@@ -1,58 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-
-const path = require('path');
-const fs = require('./fs-utils');
-const { validateConfig } = require('./config-validator');
-
-async function loadConfig(configPath) {
-  const cwd = process.cwd();
-  let absoluteConfigPath = path.resolve(cwd, configPath);
-
-  // 1. Check if the requested config file exists
-  if (!await fs.pathExists(absoluteConfigPath)) {
-    // 2. Fallback Logic:
-    // If the user didn't specify a custom path (i.e., using default 'docmd.config.js')
-    // AND 'docmd.config.js' is missing...
-    // Check if legacy 'config.js' exists.
-    if (configPath === 'docmd.config.js') {
-      const legacyPath = path.resolve(cwd, 'config.js');
-      if (await fs.pathExists(legacyPath)) {
-        // console.log('⚠️  Using legacy config.js. Please rename to docmd.config.js'); // Optional warning
-        absoluteConfigPath = legacyPath;
-      } else {
-        // Neither exists
-        throw new Error(`Configuration file not found at: ${absoluteConfigPath}\nRun "docmd init" to create one.`);
-      }
-    } else {
-      // User specified a custom path that doesn't exist
-      throw new Error(`Configuration file not found at: ${absoluteConfigPath}`);
-    }
-  }
-
-  try {
-    // Clear require cache to always get the freshest config (important for dev mode reloading)
-    delete require.cache[require.resolve(absoluteConfigPath)];
-    const config = require(absoluteConfigPath);
-
-    // Validate configuration call
-    validateConfig(config);
-
-    // Basic validation and defaults
-    config.base = config.base || '/';
-    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) {
-    if (e.message === 'Invalid configuration file.') {
-      throw e;
-    }
-    throw new Error(`Error parsing config file: ${e.message}`);
-  }
-}
-
-module.exports = { loadConfig };

package/src/core/config-validator.js

@@ -1,80 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-
-const chalk = require('chalk');
-
-// Known configuration keys for typo detection
-const KNOWN_KEYS = [
-  'siteTitle', 'siteUrl', 'srcDir', 'outputDir', 'logo', 
-  'sidebar', 'theme', 'customJs', 'autoTitleFromH1', 
-  'copyCode', 'plugins', 'navigation', 'footer', 'sponsor', 'favicon',
-  'search', 'minify', 'editLink', 'pageNavigation'
-];
-
-// Common typos mapping
-const TYPO_MAPPING = {
-  'site_title': 'siteTitle',
-  'sitetitle': 'siteTitle',
-  'baseUrl': 'siteUrl',
-  'source': 'srcDir',
-  'out': 'outputDir',
-  'customCSS': 'theme.customCss',
-  'customcss': 'theme.customCss',
-  'customJS': 'customJs',
-  'customjs': 'customJs',
-  'nav': 'navigation',
-  'menu': 'navigation'
-};
-
-function validateConfig(config) {
-  const errors = [];
-  const warnings = [];
-
-  // 1. Required Fields
-  if (!config.siteTitle) {
-    errors.push('Missing required property: "siteTitle"');
-  }
-
-  // 2. Type Checking
-  if (config.navigation && !Array.isArray(config.navigation)) {
-    errors.push('"navigation" must be an Array');
-  }
-
-  if (config.customJs && !Array.isArray(config.customJs)) {
-    errors.push('"customJs" must be an Array of strings');
-  }
-
-  if (config.theme) {
-    if (config.theme.customCss && !Array.isArray(config.theme.customCss)) {
-      errors.push('"theme.customCss" must be an Array of strings');
-    }
-  }
-
-  // 3. Typos and Unknown Keys (Top Level)
-  Object.keys(config).forEach(key => {
-    if (TYPO_MAPPING[key]) {
-      warnings.push(`Found unknown property "${key}". Did you mean "${TYPO_MAPPING[key]}"?`);
-    }
-  });
-
-  // 4. Theme specific typos
-  if (config.theme) {
-    if (config.theme.customCSS) {
-      warnings.push('Found "theme.customCSS". Did you mean "theme.customCss"?');
-    }
-  }
-
-  // Output results
-  if (warnings.length > 0) {
-    console.log(chalk.yellow('\n⚠️  Configuration Warnings:'));
-    warnings.forEach(w => console.log(chalk.yellow(`   - ${w}`)));
-  }
-
-  if (errors.length > 0) {
-    console.log(chalk.red('\n❌ Configuration Errors:'));
-    errors.forEach(e => console.log(chalk.red(`   - ${e}`)));
-    console.log('');
-    throw new Error('Invalid configuration file.');
-  }
-}
-
-module.exports = { validateConfig };