npm - @knowcode/doc-builder - Versions diffs - 1.5.22 → 1.6.0 - Mend

@knowcode/doc-builder 1.5.22 → 1.6.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 (24) hide show

package/README.md +2 -8
package/cli.js +73 -0
package/doc-builder.config.js +5 -1
package/html/README.html +25 -18
package/html/css/notion-style.css +3 -3
package/html/documentation-index.html +12 -11
package/html/guides/authentication-guide.html +14 -13
package/html/guides/claude-workflow-guide.html +9 -8
package/html/guides/documentation-standards.html +12 -11
package/html/guides/phosphor-icons-guide.html +12 -11
package/html/guides/{google-site-verification-guide.html → search-engine-verification-guide.html} +147 -43
package/html/guides/seo-guide.html +12 -11
package/html/guides/seo-optimization-guide.html +10 -9
package/html/guides/troubleshooting-guide.html +9 -8
package/html/guides/windows-setup-guide.html +9 -8
package/html/index.html +25 -18
package/html/launch/README.html +12 -11
package/html/launch/bubble-plugin-specification.html +12 -11
package/html/launch/go-to-market-strategy.html +12 -11
package/html/launch/launch-announcements.html +12 -11
package/html/sitemap.xml +27 -21
package/html/vercel-cli-setup-guide.html +12 -11
package/html/vercel-first-time-setup-guide.html +53 -37
package/package.json +1 -1

package/html/vercel-first-time-setup-guide.html CHANGED Viewed

@@ -3,8 +3,8 @@
 <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 streamlined Vercel deployment process when using `@knowcode/doc-builder deploy`. The new Vercel CLI experience has fewer...">
-    <title>Vercel First-Time Setup Guide - Simplified Process</title>
+    <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="author" content="Lindsay Smith">
     <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, deployment">
@@ -14,22 +14,23 @@
     <!-- 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 - Simplified Process">
-    <meta property="og:description" content="This guide walks you through the streamlined Vercel deployment process when using `@knowcode/doc-builder deploy`. The new Vercel CLI experience has fewer...">
+    <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="Doc Builder">
+    <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 - Simplified Process">
-    <meta name="twitter:description" content="This guide walks you through the streamlined Vercel deployment process when using `@knowcode/doc-builder deploy`. The new Vercel CLI experience has fewer...">
+    <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">
@@ -51,8 +52,8 @@
 {
   "@context": "https://schema.org",
   "@type": "TechArticle",
-  "headline": "Vercel First-Time Setup Guide - Simplified Process",
-  "description": "This guide walks you through the streamlined Vercel deployment process when using `@knowcode/doc-builder deploy`. The new Vercel CLI experience has fewer...",
+  "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"
@@ -62,8 +63,8 @@
     "name": "Knowcode Ltd",
     "url": "https://knowcode.tech"
   },
-  "datePublished": "2025-07-22T18:55:04.192Z",
-  "dateModified": "2025-07-22T18:55:04.192Z",
+  "datePublished": "2025-07-22T21:00:00.589Z",
+  "dateModified": "2025-07-22T21:00:00.589Z",
   "mainEntityOfPage": {
     "@type": "WebPage",
     "@id": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html"
@@ -74,7 +75,7 @@
       {
         "@type": "ListItem",
         "position": 1,
-        "name": "Doc Builder",
+        "name": "@knowcode/doc-builder",
         "item": "https://doc-builder-delta.vercel.app"
       },
       {
@@ -92,11 +93,11 @@
     <!-- Header -->
     <header class="header">
         <div class="header-content">
-            <a href="/index.html" class="logo">Doc Builder</a>
+            <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.5.21">Last updated: Jul 22, 2025, 06:55 PM UTC</span>
+                    <span class="deployment-date" title="Built with doc-builder v1.5.23">Last updated: Jul 22, 2025, 09:00 PM UTC</span>
                 </div>
@@ -148,7 +149,7 @@
         <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</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="fas fa-file-alt"></i> Documentation Index</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="fas fa-file-alt"></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 streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
+        <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="fas fa-file-alt"></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="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -157,8 +158,8 @@
         <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><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/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site&#039;s performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification 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/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="fas fa-file-alt"></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="fas fa-file-alt"></i> Seo Guide</a>
         <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>
@@ -179,10 +180,10 @@
         <!-- Content Area -->
         <main class="content">
             <div class="content-inner">
-                <h1>Vercel First-Time Setup Guide - Simplified Process</h1>
+                <h1>Vercel First-Time Setup Guide</h1>
 <h2>Overview</h2>
-<p>This guide walks you through the streamlined Vercel deployment process when using <code>@knowcode/doc-builder deploy</code>. The new Vercel CLI experience has fewer prompts and clearer instructions, making deployment much simpler than before.</p>
-<h2>The Simplified Process</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>
@@ -204,7 +205,7 @@
 <li>Or enter your custom domain if you have one</li>
 </ul>
 <h3>Step 3: Vercel CLI Takes Over</h3>
-<p>The new Vercel CLI experience is much simpler with clearer prompts:</p>
+<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]
@@ -246,22 +247,6 @@
 </ol>
 <pre><code><i class="ph ph-check" aria-label="check"></i> Production: https://my-docs.vercel.app [copied to clipboard]
 </code></pre>
-<h2>What Changed from the Old Process?</h2>
-<p>The new Vercel CLI is much simpler:</p>
-<h3>Removed Prompts</h3>
-<ul>
-<li><i class="ph ph-x-circle" aria-label="error"></i> No more &quot;Found project xyz/html. Link to it?&quot; confusion</li>
-<li><i class="ph ph-x-circle" aria-label="error"></i> No more &quot;Link to different existing project?&quot; complexity</li>
-<li><i class="ph ph-x-circle" aria-label="error"></i> No more manual framework selection (auto-detected)</li>
-<li><i class="ph ph-x-circle" aria-label="error"></i> No more &quot;Make deployment publicly accessible?&quot; (configured later)</li>
-</ul>
-<h3>Improved Experience</h3>
-<ul>
-<li><i class="ph ph-check-circle" aria-label="checked"></i> Clearer prompts with better wording</li>
-<li><i class="ph ph-check-circle" aria-label="checked"></i> Automatic framework detection</li>
-<li><i class="ph ph-check-circle" aria-label="checked"></i> Fewer steps overall</li>
-<li><i class="ph ph-check-circle" aria-label="checked"></i> Less chance for configuration errors</li>
-</ul>
 <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>
@@ -272,12 +257,43 @@
 <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>
@@ -338,7 +354,7 @@
 <li><strong>doc-builder Issues</strong>: File on GitHub or npm</li>
 </ul>
 <hr>
-<p>This guide reflects the new, simplified Vercel deployment process. For additional Vercel CLI configuration options, see the <a href="./vercel-cli-setup-guide.md">Vercel CLI Setup Guide</a>.</p>
+<p>For additional Vercel CLI configuration options, see the <a href="./vercel-cli-setup-guide.md">Vercel CLI Setup Guide</a>.</p>
             </div>
         </main>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@knowcode/doc-builder",
-  "version": "1.5.22",
+  "version": "1.6.0",
   "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
   "main": "index.js",
   "bin": {