npm - @knowcode/doc-builder - Versions diffs - 1.9.19 → 1.9.21 - Mend

@knowcode/doc-builder 1.9.19 → 1.9.21

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

package/cli.js +15 -1
package/doc-builder.config.js +4 -2
package/doc-builder.config.js.backup.1754384764054 +124 -0
package/doc-builder.config.js.backup.1754567425847 +124 -0
package/html/README.html +12 -4
package/html/about-doc-builder.html +12 -4
package/html/documentation-index.html +12 -4
package/html/guides/authentication-default-change.html +12 -4
package/html/guides/authentication-guide.html +12 -4
package/html/guides/claude-workflow-guide.html +12 -4
package/html/guides/configuration-guide.html +12 -4
package/html/guides/documentation-standards.html +12 -4
package/html/guides/html-embedding-guide.html +12 -4
package/html/guides/image-modal-guide.html +12 -4
package/html/guides/phosphor-icons-guide.html +12 -4
package/html/guides/private-directory-authentication-troubleshooting.html +12 -4
package/html/guides/private-directory-authentication.html +12 -4
package/html/guides/public-site-deployment.html +12 -4
package/html/guides/search-engine-verification-guide.html +12 -4
package/html/guides/seo-guide.html +12 -4
package/html/guides/seo-optimization-guide.html +12 -4
package/html/guides/supabase-authentication-complete-guide.html +12 -4
package/html/guides/troubleshooting-guide.html +12 -4
package/html/guides/windows-setup-guide.html +12 -4
package/html/image-modal-test.html +12 -4
package/html/index.html +12 -4
package/html/private/cache-control-anti-pattern.html +12 -4
package/html/private/launch/README.html +12 -4
package/html/private/launch/auth-cleanup-summary.html +12 -4
package/html/private/launch/bubble-plugin-specification.html +12 -4
package/html/private/launch/go-to-market-strategy.html +12 -4
package/html/private/launch/launch-announcements.html +12 -4
package/html/private/launch/vercel-deployment-auth-setup.html +12 -4
package/html/private/next-steps-walkthrough.html +12 -4
package/html/private/supabase-auth-implementation-completed.html +12 -4
package/html/private/supabase-auth-implementation-plan.html +12 -4
package/html/private/supabase-auth-integration-plan.html +12 -4
package/html/private/supabase-auth-setup-guide.html +12 -4
package/html/private/test-private-doc.html +12 -4
package/html/private/user-management-tooling.html +12 -4
package/html/prompts/beautiful-documentation-design.html +12 -4
package/html/prompts/markdown-document-standards.html +12 -4
package/html/prompts/project-rename-strategy-sasha-publish.html +12 -4
package/html/sitemap.xml +74 -56
package/html/test-questions/how-does-it-work%3F.html +290 -0
package/html/test-questions/step-1%3A%20getting-started.html +285 -0
package/html/test-questions/what-is-the-purpose.html +289 -0
package/html/vercel-cli-setup-guide.html +12 -4
package/html/vercel-first-time-setup-guide.html +12 -4
package/html-static/404.html +115 -0
package/html-static/README.html +456 -0
package/html-static/about-doc-builder.html +425 -0
package/html-static/css/notion-style.css +2426 -0
package/html-static/documentation-index.html +405 -0
package/html-static/guides/authentication-default-change.html +304 -0
package/html-static/guides/authentication-guide.html +443 -0
package/html-static/guides/claude-workflow-guide.html +1008 -0
package/html-static/guides/configuration-guide.html +406 -0
package/html-static/guides/documentation-standards.html +628 -0
package/html-static/guides/html-embedding-guide.html +395 -0
package/html-static/guides/image-modal-guide.html +449 -0
package/html-static/guides/phosphor-icons-guide.html +518 -0
package/html-static/guides/private-directory-authentication-troubleshooting.html +489 -0
package/html-static/guides/private-directory-authentication.html +475 -0
package/html-static/guides/public-site-deployment.html +365 -0
package/html-static/guides/search-engine-verification-guide.html +476 -0
package/html-static/guides/seo-guide.html +595 -0
package/html-static/guides/seo-optimization-guide.html +821 -0
package/html-static/guides/supabase-authentication-complete-guide.html +800 -0
package/html-static/guides/troubleshooting-guide.html +567 -0
package/html-static/guides/windows-setup-guide.html +793 -0
package/html-static/image-modal-test.html +252 -0
package/html-static/index.html +456 -0
package/html-static/js/main.js +1692 -0
package/html-static/prompts/beautiful-documentation-design.html +718 -0
package/html-static/prompts/markdown-document-standards.html +356 -0
package/html-static/prompts/project-rename-strategy-sasha-publish.html +464 -0
package/html-static/robots.txt +5 -0
package/html-static/sitemap.xml +189 -0
package/html-static/test-questions/how-does-it-work%3F.html +228 -0
package/html-static/test-questions/step-1%3A%20getting-started.html +223 -0
package/html-static/test-questions/what-is-the-purpose.html +227 -0
package/html-static/vercel-cli-setup-guide.html +429 -0
package/html-static/vercel-first-time-setup-guide.html +388 -0
package/lib/config.js +9 -2
package/lib/core-builder.js +167 -6
package/package.json +1 -1

package/html-static/vercel-first-time-setup-guide.html ADDED Viewed

@@ -0,0 +1,388 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
+    <title>Vercel First-Time Setup Guide | @knowcode/doc-builder</title>
+    <meta name="generator" content="@knowcode/doc-builder by Knowcode Ltd">
+    <meta name="author" content="Lindsay Smith">
+    <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, deployment">
+    <meta name="robots" content="index, follow">
+    <link rel="canonical" href="https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html">
+    <!-- Open Graph / Facebook -->
+    <meta property="og:type" content="article">
+    <meta property="og:url" content="https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html">
+    <meta property="og:title" content="Vercel First-Time Setup Guide | @knowcode/doc-builder">
+    <meta property="og:description" content="This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
+    <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="Vercel First-Time Setup Guide | @knowcode/doc-builder">
+    <meta name="twitter:description" content="This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
+    <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">
+    <!-- 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>
+    <!-- Styles -->
+    <link rel="stylesheet" href="/css/notion-style.css">
+    <!-- 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": "Vercel First-Time Setup Guide",
+  "description": "This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.",
+  "author": {
+    "@type": "Person",
+    "name": "Lindsay Smith"
+  },
+  "publisher": {
+    "@type": "Organization",
+    "name": "Knowcode Ltd",
+    "url": "https://knowcode.tech"
+  },
+  "datePublished": "2025-08-07T11:50:26.113Z",
+  "dateModified": "2025-08-07T11:50:26.113Z",
+  "mainEntityOfPage": {
+    "@type": "WebPage",
+    "@id": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.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": "Vercel First Time Setup Guide",
+        "item": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html"
+      }
+    ]
+  }
+}
+</script>
+</head>
+<body>
+    <!-- Header -->
+    <header class="header">
+        <div class="header-content">
+            <a href="/index.html" class="logo">@knowcode/doc-builder</a>
+            <div class="header-actions">
+                <div class="deployment-info">
+                    <span class="deployment-date" title="Built with doc-builder v1.9.20">Last updated: Aug 7, 2025, 11:50 AM UTC</span>
+                </div>
+                <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
+                    <i class="fas fa-moon"></i>
+                </button>
+                <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
+                    <i class="fas fa-bars"></i>
+                </button>
+            </div>
+        </div>
+    </header>
+    <!-- Breadcrumbs -->
+    <nav class="breadcrumbs" id="breadcrumbs">
+        <!-- Breadcrumbs will be generated by JavaScript -->
+    </nav>
+    <!-- Main Content -->
+    <div class="main-wrapper">
+        <!-- Sidebar -->
+        <aside class="sidebar">
+            <div class="sidebar-header">
+                <div class="filter-box">
+                    <input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
+                    <i class="fas fa-search filter-icon"></i>
+                </div>
+            </div>
+            <nav class="navigation">
+      <div class="nav-section" data-level="0">
+        <a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
+          <i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
+        </a>
+        <div class="nav-content">
+        <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
+        <a href="/about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> About Doc Builder</a>
+        <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Index</a>
+        <a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="ph ph-file-text"></i> Image Modal Test</a>
+        <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel Cli Setup Guide</a>
+        <a href="/vercel-first-time-setup-guide.html" class="nav-item active" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel First Time Setup Guide</a></div></div>
+      <div class="nav-section" data-level="1">
+        <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
+          <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
+        </a>
+        <div class="nav-content collapsed" id="nav-guides-1">
+        <a href="/guides/authentication-default-change.html" class="nav-item" data-tooltip="Starting from version 1.7.4, @knowcode/doc-builder now defaults to no authentication for all documentation sites."><i class="ph ph-file-text"></i> Authentication Default Change</a>
+        <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="ph ph-check-circle" style="color: #059669;"></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="ph ph-pencil-simple" style="color: #d97706;"></i> Claude Workflow Guide</a>
+        <a href="/guides/configuration-guide.html" class="nav-item" data-tooltip="This guide explains how @knowcode/doc-builder handles configuration files and settings."><i class="ph ph-check-circle" style="color: #059669;"></i> Configuration 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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Standards</a>
+        <a href="/guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="ph ph-check-circle" style="color: #059669;"></i> Html Embedding Guide</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="ph ph-check-circle" style="color: #059669;"></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="ph ph-pencil-simple" style="color: #d97706;"></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="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication</a>
+        <a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication Troubleshooting</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="ph ph-check-circle" style="color: #059669;"></i> Public Site Deployment</a>
+        <a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="ph ph-check-circle" style="color: #059669;"></i> Search Engine Verification Guide</a>
+        <a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="ph ph-check-circle" style="color: #059669;"></i> Seo Guide</a>
+        <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."><i class="ph ph-check-circle" style="color: #059669;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
+        <a href="/guides/supabase-authentication-complete-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes built-in Supabase authentication that provides enterprise-grade security with zero configuration."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Authentication Complete 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="ph ph-check-circle" style="color: #059669;"></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="ph ph-check-circle" style="color: #059669;"></i> Windows Setup Guide</a></div></div>
+      <div class="nav-section" data-level="1">
+        <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
+          <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
+        </a>
+        <div class="nav-content collapsed" id="nav-prompts-1">
+        <a href="/prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Beautiful Documentation Design</a>
+        <a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Markdown Document Standards</a>
+        <a href="/prompts/project-rename-strategy-sasha-publish.html" class="nav-item" data-tooltip="This document outlines the comprehensive strategy for renaming the @knowcode/doc-builder project to &quot;sasha-publish&quot;, including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
+      <div class="nav-section" data-level="1">
+        <a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
+          <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
+        </a>
+        <div class="nav-content collapsed" id="nav-test-questions-1">
+        <a href="/test-questions/how-does-it-work%3F.html" class="nav-item" data-tooltip="This is a test file to verify that question marks work properly in filenames."><i class="ph ph-file-text"></i> How Does It Work?</a>
+        <a href="/test-questions/step-1%3A%20getting-started.html" class="nav-item" data-tooltip="Step 1: Getting Started."><i class="ph ph-file-text"></i> Step 1: Getting Started</a>
+        <a href="/test-questions/what-is-the-purpose.html" class="nav-item" data-tooltip="Understanding the purpose of our documentation system"><i class="ph ph-file-text"></i> What Is The Purpose?</a></div></div>
+            </nav>
+            <div class="resize-handle"></div>
+        </aside>
+        <!-- Content Area -->
+        <main class="content">
+            <div class="content-inner">
+                <h1>Vercel First-Time Setup Guide</h1>
+<h2>Overview</h2>
+<p>This guide walks you through the Vercel deployment process when using <code>@knowcode/doc-builder deploy</code>.</p>
+<h2>The Deployment Process</h2>
+<h3>Step 1: Run the Deploy Command</h3>
+<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
+</code></pre>
+<h3>Step 2: doc-builder Configuration</h3>
+<p>The tool will ask a few simple questions:</p>
+<h4>Project Name</h4>
+<pre><code>? What is your project name? › my-docs
+</code></pre>
+<ul>
+<li>This becomes your Vercel project identifier</li>
+<li>Will be part of your URL: <code>project-name.vercel.app</code></li>
+<li>Use lowercase letters, numbers, and hyphens only</li>
+</ul>
+<h4>Custom Production URL (Optional)</h4>
+<pre><code>? Custom production URL (optional)? ›
+</code></pre>
+<ul>
+<li>Press Enter to skip (recommended for first-time setup)</li>
+<li>Or enter your custom domain if you have one</li>
+</ul>
+<h3>Step 3: Vercel CLI Takes Over</h3>
+<p>The Vercel CLI will guide you through the following prompts:</p>
+<h4>Deploy Confirmation</h4>
+<pre><code>Vercel CLI 28.0.0
+? Set up and deploy &quot;~/path/to/your/project/html&quot;? [Y/n]
+</code></pre>
+<ul>
+<li>Answer <strong>Yes</strong> to proceed</li>
+<li>This confirms you want to deploy the current directory</li>
+</ul>
+<h4>Account Selection</h4>
+<pre><code>? Which scope do you want to deploy to? ›
+  ○ Your Name
+  ○ Your Team (if applicable)
+</code></pre>
+<ul>
+<li>Select your personal account or team</li>
+<li>Use arrow keys to navigate, Enter to select</li>
+</ul>
+<h4>Project Name Confirmation</h4>
+<pre><code>? What&#39;s your project&#39;s name? (my-docs)
+</code></pre>
+<ul>
+<li>Vercel suggests the name you provided earlier</li>
+<li>Press Enter to accept or type a new name</li>
+</ul>
+<h4>Framework Detection</h4>
+<pre><code>? In which directory is your code located? ./
+</code></pre>
+<ul>
+<li>Vercel automatically detects this is a static site</li>
+<li>Usually defaults to <code>./</code> which is correct</li>
+<li>Press Enter to accept</li>
+</ul>
+<h3>Step 4: Deployment Begins</h3>
+<p>That&#39;s it! Vercel will now:</p>
+<ol>
+<li>Upload your files</li>
+<li>Deploy to their global CDN</li>
+<li>Provide your live URL</li>
+</ol>
+<pre><code>✓ Production: https://my-docs.vercel.app [copied to clipboard]
+</code></pre>
+<h2>Post-Deployment Configuration</h2>
+<h3>Making Your Docs Public</h3>
+<p>By default, Vercel may protect your deployment. To make docs publicly accessible:</p>
+<ol>
+<li>Go to your <a href="https://vercel.com/dashboard">Vercel Dashboard</a></li>
+<li>Click on your project</li>
+<li>Navigate to <strong>Settings → Deployment Protection</strong></li>
+<li>Set <strong>Vercel Authentication</strong> to <strong>Disabled</strong></li>
+<li>Click <strong>Save</strong></li>
+</ol>
+<h3>SEO Optimization</h3>
+<p>Once deployed, optimize your documentation for search engines:</p>
+<ol>
+<li><p><strong>Check SEO Status</strong>:</p>
+<pre><code class="language-bash">npx @knowcode/doc-builder@latest seo-check
+</code></pre>
+</li>
+<li><p><strong>Configure SEO Settings</strong>:</p>
+<pre><code class="language-bash">npx @knowcode/doc-builder@latest setup-seo
+</code></pre>
+</li>
+<li><p><strong>Review the SEO Guide</strong>: See our comprehensive <a href="./guides/seo-optimization-guide.md">SEO Optimization Guide</a> for best practices</p>
+</li>
+</ol>
+<h3>Google Search Console Setup</h3>
+<p>Make your documentation discoverable on Google:</p>
+<ol>
+<li><p><strong>Add Verification</strong>:</p>
+<pre><code class="language-bash">npx @knowcode/doc-builder@latest google-verify YOUR_VERIFICATION_CODE
+</code></pre>
+</li>
+<li><p><strong>Submit Sitemap</strong>: </p>
+<ul>
+<li>Your sitemap is automatically generated at <code>/sitemap.xml</code></li>
+<li>Submit it in Google Search Console</li>
+</ul>
+</li>
+<li><p><strong>Full Instructions</strong>: See the <a href="./guides/search-engine-verification-guide.md">Search Engine Verification Guide</a></p>
+</li>
+</ol>
+<h3>Custom Domain (Optional)</h3>
+<p>To add a custom domain:</p>
+<ol>
+<li>Go to <strong>Settings → Domains</strong></li>
+<li>Add your domain</li>
+<li>Follow DNS configuration instructions</li>
+<li>Update your sitemap URL in Google Search Console</li>
+</ol>
+<h3>Environment Variables (If Using Authentication)</h3>
+<p>If you enabled authentication in doc-builder:</p>
+<ol>
+<li>Go to <strong>Settings → Environment Variables</strong></li>
+<li>Add your auth credentials</li>
+<li>Redeploy to apply changes</li>
+</ol>
+<h2>Troubleshooting</h2>
+<h3>&quot;Vercel CLI not found&quot;</h3>
+<p>If you see this error, install Vercel CLI:</p>
+<pre><code class="language-bash">npm install -g vercel
+</code></pre>
+<h3>&quot;404 Not Found&quot; After Deployment</h3>
+<p>Make sure you:</p>
+<ol>
+<li>Ran the deploy command from your project root</li>
+<li>Have markdown files in your <code>docs/</code> folder</li>
+<li>Didn&#39;t modify the build output</li>
+</ol>
+<h3>&quot;Authentication Required&quot; Error</h3>
+<p>Your deployment is protected. Follow the &quot;Making Your Docs Public&quot; steps above.</p>
+<h3>Deployment Fails</h3>
+<p>Check that:</p>
+<ol>
+<li>You&#39;re using the latest version: <code>npx @knowcode/doc-builder@latest deploy</code></li>
+<li>Your <code>docs/</code> folder contains <code>.md</code> files</li>
+<li>You have internet connection</li>
+</ol>
+<h2>Quick Checklist</h2>
+<pre><code>✅ 1. Run: npx @knowcode/doc-builder@latest deploy
+✅ 2. Enter project name (e.g., my-docs)
+✅ 3. Skip custom URL (press Enter)
+✅ 4. Confirm deployment when Vercel asks
+✅ 5. Select your account/scope
+✅ 6. Accept suggested project name
+✅ 7. Get your live URL!
+</code></pre>
+<h2>Best Practices</h2>
+<ol>
+<li><strong>First Time</strong>: Just accept all defaults</li>
+<li><strong>Project Names</strong>: Use descriptive names like <code>company-api-docs</code></li>
+<li><strong>Custom Domains</strong>: Add them after successful deployment</li>
+<li><strong>Updates</strong>: Future deploys are even simpler - just run the same command</li>
+</ol>
+<h2>Next Steps</h2>
+<p>After successful deployment:</p>
+<ol>
+<li>Visit your live docs at the provided URL</li>
+<li>Make your docs public in Vercel settings if needed</li>
+<li>Add a custom domain if desired</li>
+<li>Share your documentation with the world!</li>
+</ol>
+<h2>Getting Help</h2>
+<ul>
+<li><strong>Vercel Dashboard</strong>: <a href="https://vercel.com/dashboard">https://vercel.com/dashboard</a></li>
+<li><strong>Vercel Support</strong>: <a href="https://vercel.com/support">https://vercel.com/support</a></li>
+<li><strong>doc-builder Issues</strong>: File on GitHub or npm</li>
+</ul>
+<hr>
+<p>For additional Vercel CLI configuration options, see the <a href="./vercel-cli-setup-guide.md">Vercel CLI Setup Guide</a>.</p>
+            </div>
+        </main>
+    </div>
+    <!-- Scripts -->
+    <script>
+    // Pass configuration to frontend
+    window.docBuilderConfig = {
+      features: {
+        showPdfDownload: true,
+        menuDefaultOpen: false,
+        mermaidEnhanced: true
+      }
+    };
+    </script>
+    <script src="/js/main.js"></script>
+</body>
+</html>

package/lib/config.js CHANGED Viewed

@@ -41,9 +41,13 @@ const defaultConfig = {
     dynamicNavIcons: true,     // Use status-based icons in navigation
     subtleColors: true,        // Apply subtle colors to status icons
     privateDirectoryAuth: false, // Enable auth for private directories only (auto-detected)
-    banner: false              // Show preview banner at top of pages
+    banner: false,             // Show preview banner at top of pages
+    staticOutput: true         // Generate static version without auth (default: true)
   },
+  // Static output configuration
+  staticOutputDir: 'html-static',  // Directory for static HTML output (no auth, no private content)
   // Authentication - Supabase only (basic auth removed for security)
   auth: {
     supabaseUrl: sharedAuth.supabaseUrl,
@@ -140,9 +144,12 @@ const notionInspiredPreset = {
     showPdfDownload: true,
     menuDefaultOpen: true,
     attachments: true,
-    banner: false              // Show preview banner at top of pages
+    banner: false,              // Show preview banner at top of pages
+    staticOutput: true         // Generate static version without auth (default: true)
   },
+  staticOutputDir: 'html-static',  // Directory for static HTML output
   auth: {
     supabaseUrl: process.env.SUPABASE_URL || sharedAuth.supabaseUrl,
     supabaseAnonKey: process.env.SUPABASE_ANON_KEY || sharedAuth.supabaseAnonKey