npm - @mgks/docmd - Versions diffs - 0.3.9 → 0.4.0 - Mend

@mgks/docmd 0.3.9 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

package/README.md +15 -160
package/bin/docmd.js +6 -69
package/package.json +6 -79
package/bin/postinstall.js +0 -14
package/src/assets/css/docmd-highlight-dark.css +0 -86
package/src/assets/css/docmd-highlight-light.css +0 -86
package/src/assets/css/docmd-main.css +0 -1736
package/src/assets/css/docmd-theme-retro.css +0 -867
package/src/assets/css/docmd-theme-ruby.css +0 -629
package/src/assets/css/docmd-theme-sky.css +0 -617
package/src/assets/favicon.ico +0 -0
package/src/assets/images/docmd-logo-dark.png +0 -0
package/src/assets/images/docmd-logo-light.png +0 -0
package/src/assets/js/docmd-image-lightbox.js +0 -74
package/src/assets/js/docmd-main.js +0 -260
package/src/assets/js/docmd-mermaid.js +0 -205
package/src/assets/js/docmd-search.js +0 -218
package/src/commands/build.js +0 -237
package/src/commands/dev.js +0 -352
package/src/commands/init.js +0 -277
package/src/commands/live.js +0 -145
package/src/core/asset-manager.js +0 -72
package/src/core/config-loader.js +0 -58
package/src/core/config-validator.js +0 -80
package/src/core/file-processor.js +0 -103
package/src/core/fs-utils.js +0 -40
package/src/core/html-generator.js +0 -184
package/src/core/icon-renderer.js +0 -106
package/src/core/logger.js +0 -21
package/src/core/markdown/containers.js +0 -94
package/src/core/markdown/renderers.js +0 -90
package/src/core/markdown/rules.js +0 -402
package/src/core/markdown/setup.js +0 -113
package/src/core/navigation-helper.js +0 -74
package/src/index.js +0 -12
package/src/live/core.js +0 -67
package/src/live/index.html +0 -216
package/src/live/live.css +0 -256
package/src/live/shims.js +0 -1
package/src/plugins/analytics.js +0 -48
package/src/plugins/seo.js +0 -107
package/src/plugins/sitemap.js +0 -127
package/src/templates/layout.ejs +0 -187
package/src/templates/navigation.ejs +0 -87
package/src/templates/no-style.ejs +0 -166
package/src/templates/partials/theme-init.js +0 -30
package/src/templates/toc.ejs +0 -38

package/src/live/index.html DELETED Viewed

@@ -1,216 +0,0 @@
-<!-- Source file from the docmd project — https://github.com/docmd-io/docmd -->
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Docmd Live Editor</title>
-    <meta name="description" content="Real-time Markdown preview and editor powered by docmd.">
-    <link rel="icon" href="favicon.ico" type="image/x-icon" sizes="any">
-    <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
-    <link rel="stylesheet" href="live.css">
-    <script src="docmd-live.js"></script>
-    <script async src="https://www.googletagmanager.com/gtag/js?id=G-VCMQ0MCSHN"></script>
-    <script>
-        window.dataLayer = window.dataLayer || [];
-        function gtag(){dataLayer.push(arguments);}
-        gtag('js', new Date());
-        gtag('config', 'G-VCMQ0MCSHN');
-    </script>
-</head>
-<body class="mode-split mobile-tab-editor">
-    <!-- Top Bar (Desktop) -->
-    <div class="top-bar">
-        <div class="logo">
-            <a href="/" class="back-link" id="back-btn" title="Back to Home" aria-label="Back to Home">
-                <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
-                    <path d="m12 19-7-7 7-7"/>
-                    <path d="M19 12H5"/>
-                </svg>
-            </a>
-            docmd <span>Live</span>
-        </div>
-        <div class="view-controls desktop-only">
-            <button class="view-btn active" onclick="setViewMode('split')" id="btn-split">Split View</button>
-            <button class="view-btn" onclick="setViewMode('single')" id="btn-single">Single View</button>
-        </div>
-        <!-- Single View Tabs (Visible only when in Single Mode on Desktop) -->
-        <div class="view-controls" id="single-view-tabs" style="display:none;">
-            <button class="view-btn active" onclick="switchSingleTab('editor')" id="btn-tab-edit">Editor</button>
-            <button class="view-btn" onclick="switchSingleTab('preview')" id="btn-tab-prev">Preview</button>
-        </div>
-    </div>
-    <!-- Workspace -->
-    <div class="workspace" id="workspace">
-        <!-- Editor -->
-        <div class="pane editor-pane" id="editorPane">
-            <div class="pane-header">Markdown</div>
-            <textarea id="input" spellcheck="false">---
-title: My Page
-description: Start editing to see changes instantly.
----
-# Hello World
-This is a **live** preview.
-::: callout tip
-Try resizing the window or switching to mobile view!
-:::
-## Features
-1. Responsive Design
-2. Split or Tabbed view
-3. Instant Rendering
-</textarea>
-        </div>
-        <!-- Resizer Handle -->
-        <div class="resizer" id="resizer"></div>
-        <!-- Preview -->
-        <div class="pane preview-pane" id="previewPane">
-            <div class="pane-header">Preview</div>
-            <iframe id="preview"></iframe>
-        </div>
-    </div>
-    <!-- Mobile Bottom Tabs -->
-    <div class="mobile-tabs">
-        <button class="mobile-tab-btn active" onclick="setMobileTab('editor')" id="mob-edit">Editor</button>
-        <button class="mobile-tab-btn" onclick="setMobileTab('preview')" id="mob-prev">Preview</button>
-    </div>
-    <script>
-        // --- Core Logic ---
-        const input = document.getElementById('input');
-        const preview = document.getElementById('preview');
-        const backBtn = document.getElementById('back-btn');
-        function render() {
-            try {
-                let html = docmd.compile(input.value, {
-                    siteTitle: 'My Project', // User can change this in real config, but here we set a default
-                    search: false,
-                    theme: { name: 'sky', defaultMode: 'light' },
-                    sidebar: { collapsible: false }
-                });
-                // --- INJECTIONS ---
-                // 1. Force links to open in new tab (Fixes infinite iframe recursion)
-                html = html.replace('<head>', '<head><base target="_blank">');
-                // 2. Hide Sidebar Header via CSS
-                const customStyle = `
-                    <style>
-                        .sidebar-header { display: none !important; }
-                        .sidebar-nav { margin-top: 1rem; }
-                    </style>
-                `;
-                html = html.replace('</body>', `${customStyle}</body>`);
-                // ------------------
-                const doc = preview.contentWindow.document;
-                doc.open();
-                doc.write(html);
-                doc.close();
-            } catch (e) { console.error(e); }
-        }
-        // Debounce Render
-        let timer;
-        input.addEventListener('input', () => {
-            clearTimeout(timer);
-            timer = setTimeout(render, 300);
-        });
-        // Initial Render
-        render();
-        // --- Resizer Logic ---
-        const resizer = document.getElementById('resizer');
-        const editorPane = document.getElementById('editorPane');
-        const workspace = document.getElementById('workspace');
-        let isResizing = false;
-        resizer.addEventListener('mousedown', (e) => {
-            isResizing = true;
-            resizer.classList.add('resizing');
-            preview.style.pointerEvents = 'none';
-            document.body.style.cursor = 'col-resize';
-        });
-        document.addEventListener('mousemove', (e) => {
-            if (!isResizing) return;
-            const containerWidth = workspace.offsetWidth;
-            const newEditorWidth = (e.clientX / containerWidth) * 100;
-            if (newEditorWidth > 15 && newEditorWidth < 85) {
-                editorPane.style.width = newEditorWidth + '%';
-            }
-        });
-        document.addEventListener('mouseup', () => {
-            if (isResizing) {
-                isResizing = false;
-                resizer.classList.remove('resizing');
-                preview.style.pointerEvents = 'auto';
-                document.body.style.cursor = 'default';
-            }
-        });
-        // --- View Mode Logic (Desktop) ---
-        function setViewMode(mode) {
-            document.body.classList.remove('mode-split', 'mode-single');
-            document.body.classList.add('mode-' + mode);
-            document.getElementById('btn-split').classList.toggle('active', mode === 'split');
-            document.getElementById('btn-single').classList.toggle('active', mode === 'single');
-            document.getElementById('single-view-tabs').style.display = mode === 'single' ? 'flex' : 'none';
-            if (mode === 'single') {
-                switchSingleTab('editor');
-            }
-        }
-        function switchSingleTab(tab) {
-            document.body.classList.remove('show-editor', 'show-preview');
-            document.body.classList.add('show-' + tab);
-            document.getElementById('btn-tab-edit').classList.toggle('active', tab === 'editor');
-            document.getElementById('btn-tab-prev').classList.toggle('active', tab === 'preview');
-        }
-        // --- Mobile Logic ---
-        function setMobileTab(tab) {
-            document.body.classList.remove('mobile-tab-editor', 'mobile-tab-preview');
-            document.body.classList.add('mobile-tab-' + tab);
-            document.getElementById('mob-edit').classList.toggle('active', tab === 'editor');
-            document.getElementById('mob-prev').classList.toggle('active', tab === 'preview');
-        }
-        // --- Back Button Logic ---
-        if (window.history.length <= 1) {
-            backBtn.style.display = 'none';
-        } else {
-            backBtn.addEventListener('click', (e) => {
-                e.preventDefault();
-                window.history.back();
-            });
-        }
-    </script>
-</body>
-</html>

package/src/live/live.css DELETED Viewed

@@ -1,256 +0,0 @@
-/* Source file from the docmd project — https://github.com/docmd-io/docmd */
-:root {
-    --header-height: 50px;
-    --border-color: #e0e0e0;
-    --bg-color: #f9fafb;
-    --primary-color: #007bff;
-    --resizer-width: 8px
-}
-body {
-    margin: 0;
-    height: 100vh;
-    display: flex;
-    flex-direction: column;
-    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
-    overflow: hidden
-}
-.top-bar {
-    height: var(--header-height);
-    background: #fff;
-    border-bottom: 1px solid var(--border-color);
-    display: flex;
-    align-items: center;
-    justify-content: space-between;
-    padding: 0 1rem;
-    flex-shrink: 0
-}
-.logo {
-    font-weight: 700;
-    font-size: 1.1rem;
-    display: flex;
-    align-items: center;
-    gap: 12px
-}
-.logo span {
-    background: var(--primary-color);
-    color: #fff;
-    padding: 2px 6px;
-    border-radius: 4px;
-    font-size: .75rem;
-    text-transform: uppercase
-}
-.back-link {
-    display: flex;
-    align-items: center;
-    justify-content: center;
-    color: #666;
-    transition: color 0.2s, transform .2s;
-    text-decoration: none;
-    padding: 4px;
-    border-radius: 4px
-}
-.back-link:hover {
-    color: var(--primary-color);
-    background: #f0f0f0;
-    transform: translateX(-2px)
-}
-.view-controls {
-    display: flex;
-    gap: 8px;
-    background: #f0f0f0;
-    padding: 3px;
-    border-radius: 6px
-}
-.view-btn {
-    border: none;
-    background: transparent;
-    padding: 6px 10px;
-    border-radius: 4px;
-    cursor: pointer;
-    font-size: .85rem;
-    color: #666;
-    font-weight: 500
-}
-.view-btn.active {
-    background: #fff;
-    color: #000;
-    box-shadow: 0 1px 3px #0000001a
-}
-.workspace {
-    flex: 1;
-    display: flex;
-    position: relative;
-    overflow: hidden
-}
-.pane {
-    height: 100%;
-    display: flex;
-    flex-direction: column;
-    min-width: 300px;
-    background: #fff
-}
-.pane-header {
-    padding: 8px 16px;
-    font-size: .75rem;
-    font-weight: 600;
-    text-transform: uppercase;
-    color: #888;
-    background: var(--bg-color);
-    border-bottom: 1px solid var(--border-color);
-    flex-shrink: 0
-}
-.editor-pane {
-    width: 50%
-}
-textarea#input {
-    flex: 1;
-    border: none;
-    resize: none;
-    padding: 20px;
-    font-family: 'JetBrains Mono', 'Fira Code', Consolas, monospace;
-    font-size: 14px;
-    line-height: 1.6;
-    outline: none;
-    background: var(--bg-color)
-}
-.preview-pane {
-    flex: 1;
-    background: #fff
-}
-iframe#preview {
-    width: 100%;
-    height: 100%;
-    border: none;
-    display: block
-}
-.resizer {
-    width: var(--resizer-width);
-    background: var(--bg-color);
-    border-left: 1px solid var(--border-color);
-    border-right: 1px solid var(--border-color);
-    cursor: col-resize;
-    display: flex;
-    align-items: center;
-    justify-content: center;
-    transition: background .2s;
-    z-index: 10
-}
-.resizer:hover,
-.resizer.resizing {
-    background: #e0e0e0
-}
-.resizer::after {
-    content: "||";
-    color: #aaa;
-    font-size: 10px;
-    letter-spacing: 1px
-}
-body.mode-single .resizer {
-    display: none
-}
-body.mode-single .pane {
-    width: 100% !important;
-    min-width: 0
-}
-body.mode-single .editor-pane {
-    display: none
-}
-body.mode-single .preview-pane {
-    display: none
-}
-body.mode-single.show-editor .editor-pane {
-    display: flex
-}
-body.mode-single.show-preview .preview-pane {
-    display: flex
-}
-@media (max-width: 768px) {
-    .desktop-only {
-        display: none !important
-    }
-    .resizer {
-        display: none !important
-    }
-    .pane {
-        width: 100% !important
-    }
-    .editor-pane {
-        display: none
-    }
-    .preview-pane {
-        display: none
-    }
-    body.mobile-tab-editor .editor-pane {
-        display: flex
-    }
-    body.mobile-tab-preview .preview-pane {
-        display: flex
-    }
-    .mobile-tabs {
-        display: flex !important;
-        position: fixed;
-        bottom: 0;
-        left: 0;
-        right: 0;
-        height: 50px;
-        background: #fff;
-        border-top: 1px solid var(--border-color);
-        z-index: 100
-    }
-    .mobile-tab-btn {
-        flex: 1;
-        border: none;
-        background: transparent;
-        font-weight: 600;
-        color: #888;
-        cursor: pointer
-    }
-    .mobile-tab-btn.active {
-        color: var(--primary-color);
-        border-top: 2px solid var(--primary-color)
-    }
-    .workspace {
-        padding-bottom: 50px
-    }
-}
-.mobile-tabs {
-    display: none
-}

package/src/live/shims.js DELETED Viewed

	@@ -1 +0,0 @@
1	- import { Buffer } from 'buffer'; globalThis.Buffer = Buffer;

package/src/plugins/analytics.js DELETED Viewed

@@ -1,48 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-/*
- * Generate analytics scripts for a page
- */
-function generateAnalyticsScripts(config, pageData) {
-    let headScriptsHtml = '';
-    let bodyScriptsHtml = ''; // For scripts that need to be at the end of body
-    const analyticsConfig = config.plugins?.analytics || {}; // Assuming analytics is under plugins.analytics
-    // Google Analytics 4 (GA4)
-    if (analyticsConfig.googleV4?.measurementId) {
-      const id = analyticsConfig.googleV4.measurementId;
-      headScriptsHtml += `
-      <!-- Google Analytics GA4 -->
-      <script async src="https://www.googletagmanager.com/gtag/js?id=${id}"></script>
-      <script>
-        window.dataLayer = window.dataLayer || [];
-        function gtag(){dataLayer.push(arguments);}
-        gtag('js', new Date());
-        gtag('config', '${id}');
-      </script>\n`;
-    }
-    // Google Analytics Universal Analytics (UA) - Legacy
-    if (analyticsConfig.googleUA?.trackingId) {
-      const id = analyticsConfig.googleUA.trackingId;
-      headScriptsHtml += `
-      <!-- Google Universal Analytics (Legacy) -->
-      <script async src="https://www.google-analytics.com/analytics.js"></script>
-      <script>
-        window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
-        ga('create', '${id}', 'auto');
-        ga('send', 'pageview');
-      </script>\n`;
-    }
-    // Example for a hypothetical future plugin requiring body script
-    // if (config.plugins?.someOtherAnalytics?.apiKey) {
-    //   bodyScriptsHtml += `<script src="..."></script>\n`;
-    // }
-    return { headScriptsHtml, bodyScriptsHtml };
-  }
-  module.exports = { generateAnalyticsScripts };

package/src/plugins/seo.js DELETED Viewed

@@ -1,107 +0,0 @@
-// Source file from the docmd project — https://github.com/docmd-io/docmd
-/*
- * Generate SEO meta tags for a page
- */
-function generateSeoMetaTags(config, pageData, relativePathToRoot) {
-  let metaTagsHtml = '';
-  const { frontmatter, outputPath } = pageData;
-  const seoFrontmatter = frontmatter.seo || {};
-  if (frontmatter.noindex || seoFrontmatter.noindex) {
-    metaTagsHtml += '<meta name="robots" content="noindex">\n';
-    return metaTagsHtml;
-  }
-  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: ${e.message}`);
-    }
-  }
-  return metaTagsHtml;
-}
-module.exports = { generateSeoMetaTags };