npm - @knowcode/doc-builder - Versions diffs - 1.9.0 → 1.9.1 - Mend

@knowcode/doc-builder 1.9.0 → 1.9.1

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 (40) hide show

package/README.md +2 -0
package/html/README.html +34 -149
package/html/css/notion-style.css +13 -394
package/html/documentation-index.html +17 -127
package/html/guides/authentication-default-change.html +8 -130
package/html/guides/authentication-guide.html +20 -141
package/html/guides/claude-workflow-guide.html +23 -137
package/html/guides/documentation-standards.html +12 -133
package/html/guides/image-modal-guide.html +381 -0
package/html/guides/phosphor-icons-guide.html +28 -150
package/html/guides/private-directory-authentication.html +8 -130
package/html/guides/public-site-deployment.html +8 -130
package/html/guides/search-engine-verification-guide.html +8 -130
package/html/guides/seo-guide.html +8 -130
package/html/guides/seo-optimization-guide.html +39 -159
package/html/guides/troubleshooting-guide.html +20 -141
package/html/guides/windows-setup-guide.html +39 -161
package/html/image-modal-test.html +9 -125
package/html/index.html +34 -149
package/html/js/auth.js +39 -118
package/html/js/main.js +25 -259
package/html/private/cache-control-anti-pattern.html +13 -135
package/html/private/launch/README.html +16 -144
package/html/private/launch/auth-cleanup-summary.html +25 -153
package/html/private/launch/bubble-plugin-specification.html +8 -136
package/html/private/launch/go-to-market-strategy.html +10 -138
package/html/private/launch/launch-announcements.html +24 -151
package/html/private/launch/vercel-deployment-auth-setup.html +10 -138
package/html/private/next-steps-walkthrough.html +15 -137
package/html/private/supabase-auth-implementation-completed.html +22 -143
package/html/private/supabase-auth-implementation-plan.html +15 -136
package/html/private/supabase-auth-integration-plan.html +22 -142
package/html/private/supabase-auth-setup-guide.html +17 -139
package/html/private/test-private-doc.html +8 -130
package/html/private/user-management-tooling.html +8 -130
package/html/prompts/markdown-document-standards.html +13 -134
package/html/vercel-cli-setup-guide.html +12 -128
package/html/vercel-first-time-setup-guide.html +9 -125
package/lib/emoji-mapper.js +12 -0
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -36,6 +36,7 @@ npx @knowcode/doc-builder@latest deploy
 - **Scans** your markdown files and automatically generates navigation
 - **Converts** markdown to HTML with syntax highlighting and diagram support
+- **Enhances** images with clickable modals for full-screen viewing
 - **Styles** everything with a clean, Notion-inspired theme
 - **Deploys** to Vercel with a single command - leveraging their generous free tier
 - **Provides** optional features like authentication, dark mode, and changelog generation, SEO
@@ -74,6 +75,7 @@ This aligns perfectly with our mission: beautiful documentation should be access
 - 🔍 **SEO Optimized** - Meta tags & structured data
 - 🔐 **Optional Auth** - Supabase authentication (opt-in)
 - 📊 **Mermaid Diagrams** - Built-in diagram support
+- 🖼️ **Image Modals** - Click any image for full-screen view
 - 🌙 **Dark Mode** - Automatic theme switching
 - ☁️ **Vercel Deploy** - One-command deployment
 - ✅ **Google Verification** - Search Console ready

package/html/README.html CHANGED Viewed

@@ -3,41 +3,14 @@
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="description" content="&lt;div align=&quot;center&quot;&gt;">
-    <title>@knowcode/doc-builder | @knowcode/doc-builder</title>
-    <meta name="author" content="Lindsay Smith">
-    <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, width, table">
-    <meta name="robots" content="index, follow">
-    <link rel="canonical" href="https://doc-builder-delta.vercel.app/README.html">
-    <!-- Open Graph / Facebook -->
-    <meta property="og:type" content="article">
-    <meta property="og:url" content="https://doc-builder-delta.vercel.app/README.html">
-    <meta property="og:title" content="@knowcode/doc-builder | @knowcode/doc-builder">
-    <meta property="og:description" content="&lt;div align=&quot;center&quot;&gt;">
-    <meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
-    <meta property="og:site_name" content="@knowcode/doc-builder">
-    <meta property="og:locale" content="en_US">
-    <!-- Twitter Card -->
-    <meta name="twitter:card" content="summary_large_image">
-    <meta name="twitter:site" content="@planbbackups">
-    <meta name="twitter:creator" content="@planbbackups">
-    <meta name="twitter:title" content="@knowcode/doc-builder | @knowcode/doc-builder">
-    <meta name="twitter:description" content="&lt;div align=&quot;center&quot;&gt;">
-    <meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
-    <!-- Custom Meta Tags -->
-    <meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
-    <meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
+    <meta name="description" content="Beautiful documentation with the least effort possible">
+    <title>@knowcode/doc-builder - @knowcode/doc-builder</title>
     <!-- Fonts -->
     <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
     <!-- Icons -->
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
-    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
     <!-- Mermaid -->
     <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -45,84 +18,8 @@
     <!-- Styles -->
     <link rel="stylesheet" href="/css/notion-style.css">
-    <!-- Hide content until auth check -->
-    <style>
-      body {
-        visibility: hidden;
-        opacity: 0;
-        transition: opacity 0.3s ease;
-      }
-      body.authenticated {
-        visibility: visible;
-        opacity: 1;
-      }
-      /* Show login/logout pages immediately */
-      body.auth-page {
-        visibility: visible;
-        opacity: 1;
-      }
-      /* Style auth button consistently */
-      .auth-btn {
-        background: none;
-        border: none;
-        color: var(--text-secondary);
-        cursor: pointer;
-        padding: 0.5rem;
-        border-radius: 0.5rem;
-        transition: all 0.2s;
-        font-size: 1.1rem;
-      }
-      .auth-btn:hover {
-        background: var(--bg-secondary);
-        color: var(--text-primary);
-      }
-    </style>
     <!-- Favicon -->
-    <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>✨</text></svg>">
-    <script type="application/ld+json">
-{
-  "@context": "https://schema.org",
-  "@type": "TechArticle",
-  "headline": "@knowcode/doc-builder",
-  "description": "<div align=\"center\">",
-  "author": {
-    "@type": "Person",
-    "name": "Lindsay Smith"
-  },
-  "publisher": {
-    "@type": "Organization",
-    "name": "Knowcode Ltd",
-    "url": "https://knowcode.tech"
-  },
-  "datePublished": "2025-07-27T08:30:10.756Z",
-  "dateModified": "2025-07-27T08:30:10.756Z",
-  "mainEntityOfPage": {
-    "@type": "WebPage",
-    "@id": "https://doc-builder-delta.vercel.app/README.html"
-  },
-  "breadcrumb": {
-    "@type": "BreadcrumbList",
-    "itemListElement": [
-      {
-        "@type": "ListItem",
-        "position": 1,
-        "name": "@knowcode/doc-builder",
-        "item": "https://doc-builder-delta.vercel.app"
-      },
-      {
-        "@type": "ListItem",
-        "position": 2,
-        "name": "README",
-        "item": "https://doc-builder-delta.vercel.app/README.html"
-      }
-    ]
-  }
-}
-</script>
+    <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
 </head>
 <body>
     <!-- Header -->
@@ -132,14 +29,10 @@
             <div class="header-actions">
                 <div class="deployment-info">
-                    <span class="deployment-date" title="Built with doc-builder v1.9.0">Last updated: Jul 27, 2025, 08:30 AM UTC</span>
+                    <span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
                 </div>
-                <a href="../login.html" class="auth-btn" title="Login/Logout">
-                    <i class="fas fa-sign-in-alt"></i>
-                </a>
                 <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
                     <i class="fas fa-moon"></i>
@@ -199,6 +92,7 @@
         <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="fas fa-file-alt"></i> Authentication Guide</a>
         <a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
         <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
+        <a href="/guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="fas fa-file-alt"></i> Image Modal Guide</a>
         <a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="fas fa-file-alt"></i> Phosphor Icons Guide</a>
         <a href="/guides/private-directory-authentication.html" class="nav-item" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="fas fa-file-alt"></i> Private Directory Authentication</a>
         <a href="/guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="fas fa-file-alt"></i> Public Site Deployment</a>
@@ -207,7 +101,7 @@
         <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
         <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
         <a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
-      <div class="nav-section private-nav" data-level="1">
+      <div class="nav-section" data-level="1">
         <a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
           <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
         </a>
@@ -220,7 +114,7 @@
         <a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
         <a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
         <a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="fas fa-file-alt"></i> User Management Tooling</a></div></div>
-      <div class="nav-section private-nav" data-level="2">
+      <div class="nav-section" data-level="2">
         <a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
           <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
         </a>
@@ -251,26 +145,26 @@
 <p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
 </blockquote>
 <p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><img src="https://img.shields.io/npm/v/@knowcode/doc-builder" alt="npm version"></a><br><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a></p>
-<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h3>
+<h3>🚀 Quick Start</h3>
 <pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
 </code></pre>
 <p><a href="https://doc-builder-delta.vercel.app"><strong>You are looking at a demo</strong></a> | <a href="https://www.npmjs.com/package/@knowcode/doc-builder"><strong>NPM Package</strong></a> | <a href="https://github.com/wapdat/doc-builder"><strong>GitHub</strong></a></p>
 </div>
 <hr>
-<h2><i class="ph ph-sparkle" aria-label="special"></i> Features</h2>
+<h2>✨ Features</h2>
 <table>
 <tr>
 <td width="50%">
-<h3><i class="ph ph-palette" aria-label="design"></i> Design &amp; UX</h3>
+<h3>🎨 Design &amp; UX</h3>
 <ul>
 <li><strong>Notion-inspired UI</strong> - Clean, modern interface</li>
 <li><strong>Dark mode support</strong> - Automatic theme switching</li>
 <li><strong>Responsive layout</strong> - Perfect on any device</li>
 <li><strong>Syntax highlighting</strong> - Beautiful code blocks</li>
 </ul>
-<h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Navigation</h3>
+<h3>🔍 Navigation</h3>
 <ul>
 <li><strong>Full-text search</strong> - Find anything instantly</li>
 <li><strong>Smart navigation</strong> - Hierarchical structure</li>
@@ -280,14 +174,14 @@
 </td>
 <td width="50%">
-<h3><i class="ph ph-chart-bar" aria-label="chart"></i> Content Support</h3>
+<h3>📊 Content Support</h3>
 <ul>
 <li><strong>Mermaid diagrams</strong> - Visual documentation</li>
 <li><strong>GitHub markdown</strong> - Full GFM support</li>
 <li><strong>Interactive tooltips</strong> - Document previews</li>
 <li><strong>Version tracking</strong> - Build metadata</li>
 </ul>
-<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Deployment</h3>
+<h3>🚀 Deployment</h3>
 <ul>
 <li><strong>One-command deploy</strong> - Push to Vercel</li>
 <li><strong>Static generation</strong> - Fast &amp; secure</li>
@@ -298,7 +192,7 @@
 </tr>
 </table>
-<h2><i class="ph ph-target" aria-label="goal"></i> Use Cases</h2>
+<h2>🎯 Use Cases</h2>
 <table>
 <tr>
 <td width="25%">
@@ -324,7 +218,7 @@
 </tr>
 </table>
-<h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
+<h2>🛠️ Simple Workflow</h2>
 <table>
 <tr>
 <td width="50%">
@@ -344,7 +238,7 @@
 </tr>
 </table>
-<h2><i class="ph ph-gear" aria-label="settings"></i> Configuration</h2>
+<h2>⚙️ Configuration</h2>
 <p>Configuration is fully managed through the CLI tools - no manual file editing required! The tool handles all settings automatically during setup and deployment.</p>
 <table>
 <tr>
@@ -379,13 +273,14 @@ features: {
 </tr>
 </table>
-<h2><i class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Examples</h2>
+<h2>📊 Rich Content Examples</h2>
 <table>
 <tr>
 <td width="50%">
 <h3>Mermaid Diagrams</h3>
 <div class="mermaid-wrapper">
+      <div class="mermaid-title">Diagram</div>
       <div class="mermaid">graph LR
     A[Write] --> B[Build]
     B --> C[Deploy]
@@ -410,12 +305,12 @@ docBuilder.build({
 </tr>
 </table>
-<h2><i class="ph ph-star-four" aria-label="sparkle"></i> Why Choose doc-builder?</h2>
+<h2>🌟 Why Choose doc-builder?</h2>
 <table>
 <tr>
 <td width="33%">
-<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Performance</h3>
+<h3>🚀 Performance</h3>
 <ul>
 <li><strong>Lightning fast</strong> - Static generation</li>
 <li><strong>SEO optimized</strong> - Search friendly</li>
@@ -424,7 +319,7 @@ docBuilder.build({
 </td>
 <td width="33%">
-<h3><i class="ph ph-gear-six" aria-label="tools"></i> Developer Experience</h3>
+<h3>🛠️ Developer Experience</h3>
 <ul>
 <li><strong>Zero config</strong> - Works instantly</li>
 <li><strong>Version control</strong> - Git-friendly</li>
@@ -433,7 +328,7 @@ docBuilder.build({
 </td>
 <td width="33%">
-<h3><i class="ph ph-money" aria-label="money"></i> Cost Effective</h3>
+<h3>💰 Cost Effective</h3>
 <ul>
 <li><strong>Free hosting</strong> - Vercel free tier</li>
 <li><strong>No vendor lock-in</strong> - Your content</li>
@@ -443,7 +338,7 @@ docBuilder.build({
 </tr>
 </table>
-<h2><i class="ph ph-handshake" aria-label="partnership"></i> Get Involved</h2>
+<h2>🤝 Get Involved</h2>
 <table>
 <tr>
 <td width="50%">
@@ -452,10 +347,10 @@ docBuilder.build({
 <p>We welcome contributions! Check our <a href="https://github.com/wapdat/doc-builder">contribution guide</a> to get started.</p>
 <p><strong>Ways to help:</strong></p>
 <ul>
-<li><i class="ph ph-bug" aria-label="bug"></i> Report bugs</li>
-<li><i class="ph ph-lightbulb" aria-label="idea"></i> Suggest features</li>
-<li><i class="ph ph-note-pencil" aria-label="edit"></i> Improve docs</li>
-<li><i class="ph ph-wrench" aria-label="settings"></i> Submit PRs</li>
+<li>🐛 Report bugs</li>
+<li>💡 Suggest features</li>
+<li>📝 Improve docs</li>
+<li>🔧 Submit PRs</li>
 </ul>
 </td>
 <td width="50%">
@@ -464,10 +359,10 @@ docBuilder.build({
 <p>Join our growing community of documentation enthusiasts!</p>
 <p><strong>Connect with us:</strong></p>
 <ul>
-<li><i class="ph ph-package" aria-label="package"></i> <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
-<li><i class="ph ph-github-logo" aria-label="github"></i> <a href="https://github.com/wapdat/doc-builder">GitHub Repo</a></li>
-<li><i class="ph ph-globe" aria-label="global"></i> <a href="https://knowcode.com">Website</a></li>
-<li><i class="ph ph-chat-circle" aria-label="chat"></i> <a href="https://github.com/wapdat/doc-builder/discussions">Discussions</a></li>
+<li>📦 <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
+<li>🐙 <a href="https://github.com/wapdat/doc-builder">GitHub Repo</a></li>
+<li>🌐 <a href="https://knowcode.com">Website</a></li>
+<li>💬 <a href="https://github.com/wapdat/doc-builder/discussions">Discussions</a></li>
 </ul>
 </td>
 </tr>
@@ -476,8 +371,8 @@ docBuilder.build({
 <hr>
 <div align="center">
-<h3><i class="ph ph-note-pencil" aria-label="edit"></i> License: MIT © KnowCode</h3>
-<p>Built with <i class="ph ph-heart" aria-label="love"></i> by developers, for developers</p>
+<h3>📝 License: MIT © KnowCode</h3>
+<p>Built with ❤️ by developers, for developers</p>
 <p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><strong>Get Started</strong></a> | <a href="https://doc-builder-delta.vercel.app"><strong>You are looking at a demo</strong></a> | <a href="https://github.com/wapdat/doc-builder"><strong>Star on GitHub</strong></a></p>
 </div>
@@ -486,17 +381,7 @@ docBuilder.build({
     </div>
     <!-- Scripts -->
-    <script>
-    // Pass configuration to frontend
-    window.docBuilderConfig = {
-      features: {
-        showPdfDownload: true,
-        menuDefaultOpen: false
-      }
-    };
-    </script>
     <script src="/js/main.js"></script>
-    <script src="https://unpkg.com/@supabase/supabase-js@2"></script>
-    <script src="/js/auth.js"></script>
 </body>
 </html>