@knowcode/doc-builder 1.5.12 → 1.5.14

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.
package/html/sitemap.xml CHANGED
@@ -2,91 +2,97 @@
2
2
  <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
3
3
  <url>
4
4
  <loc>https://doc-builder-delta.vercel.app/404.html</loc>
5
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
5
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
6
6
  <changefreq>monthly</changefreq>
7
7
  <priority>0.6</priority>
8
8
  </url>
9
9
  <url>
10
10
  <loc>https://doc-builder-delta.vercel.app/README.html</loc>
11
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
11
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
12
12
  <changefreq>monthly</changefreq>
13
13
  <priority>0.6</priority>
14
14
  </url>
15
15
  <url>
16
16
  <loc>https://doc-builder-delta.vercel.app/claude-workflow-guide.html</loc>
17
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
17
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
18
18
  <changefreq>monthly</changefreq>
19
19
  <priority>0.8</priority>
20
20
  </url>
21
21
  <url>
22
22
  <loc>https://doc-builder-delta.vercel.app/documentation-index.html</loc>
23
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
23
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
24
24
  <changefreq>monthly</changefreq>
25
25
  <priority>0.6</priority>
26
26
  </url>
27
27
  <url>
28
28
  <loc>https://doc-builder-delta.vercel.app/guides/authentication-guide.html</loc>
29
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
29
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
30
30
  <changefreq>monthly</changefreq>
31
31
  <priority>0.8</priority>
32
32
  </url>
33
33
  <url>
34
34
  <loc>https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html</loc>
35
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
35
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
36
36
  <changefreq>monthly</changefreq>
37
37
  <priority>0.8</priority>
38
38
  </url>
39
39
  <url>
40
40
  <loc>https://doc-builder-delta.vercel.app/guides/document-standards.html</loc>
41
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
41
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
42
42
  <changefreq>monthly</changefreq>
43
43
  <priority>0.8</priority>
44
44
  </url>
45
45
  <url>
46
46
  <loc>https://doc-builder-delta.vercel.app/guides/documentation-standards.html</loc>
47
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
47
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
48
48
  <changefreq>monthly</changefreq>
49
49
  <priority>0.8</priority>
50
50
  </url>
51
51
  <url>
52
52
  <loc>https://doc-builder-delta.vercel.app/guides/google-site-verification-guide.html</loc>
53
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
53
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
54
+ <changefreq>monthly</changefreq>
55
+ <priority>0.8</priority>
56
+ </url>
57
+ <url>
58
+ <loc>https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html</loc>
59
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
54
60
  <changefreq>monthly</changefreq>
55
61
  <priority>0.8</priority>
56
62
  </url>
57
63
  <url>
58
64
  <loc>https://doc-builder-delta.vercel.app/guides/seo-guide.html</loc>
59
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
65
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
60
66
  <changefreq>monthly</changefreq>
61
67
  <priority>0.8</priority>
62
68
  </url>
63
69
  <url>
64
70
  <loc>https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html</loc>
65
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
71
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
66
72
  <changefreq>monthly</changefreq>
67
73
  <priority>0.8</priority>
68
74
  </url>
69
75
  <url>
70
76
  <loc>https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html</loc>
71
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
77
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
72
78
  <changefreq>monthly</changefreq>
73
79
  <priority>0.8</priority>
74
80
  </url>
75
81
  <url>
76
82
  <loc>https://doc-builder-delta.vercel.app/index.html</loc>
77
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
83
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
78
84
  <changefreq>weekly</changefreq>
79
85
  <priority>1.0</priority>
80
86
  </url>
81
87
  <url>
82
88
  <loc>https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html</loc>
83
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
89
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
84
90
  <changefreq>monthly</changefreq>
85
91
  <priority>0.8</priority>
86
92
  </url>
87
93
  <url>
88
94
  <loc>https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html</loc>
89
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
95
+ <lastmod>2025-07-22T11:08:52.151Z</lastmod>
90
96
  <changefreq>monthly</changefreq>
91
97
  <priority>0.8</priority>
92
98
  </url>
@@ -3,11 +3,11 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="description" content="Generated: 2025-07-21 20:30 UTC">
6
+ <meta name="description" content="Generated: 2025-07-22 UTC">
7
7
  <title>Vercel CLI Setup Guide | Doc Builder</title>
8
8
 
9
9
  <meta name="author" content="Lindsay Smith">
10
- <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, https, com">
10
+ <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, cli, https">
11
11
  <meta name="robots" content="index, follow">
12
12
  <link rel="canonical" href="https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html">
13
13
 
@@ -15,7 +15,7 @@
15
15
  <meta property="og:type" content="article">
16
16
  <meta property="og:url" content="https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html">
17
17
  <meta property="og:title" content="Vercel CLI Setup Guide | Doc Builder">
18
- <meta property="og:description" content="Generated: 2025-07-21 20:30 UTC">
18
+ <meta property="og:description" content="Generated: 2025-07-22 UTC">
19
19
  <meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
20
20
  <meta property="og:site_name" content="Doc Builder">
21
21
  <meta property="og:locale" content="en_US">
@@ -25,7 +25,7 @@
25
25
  <meta name="twitter:site" content="@planbbackups">
26
26
  <meta name="twitter:creator" content="@planbbackups">
27
27
  <meta name="twitter:title" content="Vercel CLI Setup Guide | Doc Builder">
28
- <meta name="twitter:description" content="Generated: 2025-07-21 20:30 UTC">
28
+ <meta name="twitter:description" content="Generated: 2025-07-22 UTC">
29
29
  <meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
30
30
 
31
31
  <!-- Custom Meta Tags -->
@@ -36,6 +36,7 @@
36
36
 
37
37
  <!-- Icons -->
38
38
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
39
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
39
40
 
40
41
  <!-- Mermaid -->
41
42
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -51,7 +52,7 @@
51
52
  "@context": "https://schema.org",
52
53
  "@type": "TechArticle",
53
54
  "headline": "Vercel CLI Setup Guide",
54
- "description": "Generated: 2025-07-21 20:30 UTC",
55
+ "description": "Generated: 2025-07-22 UTC",
55
56
  "author": {
56
57
  "@type": "Person",
57
58
  "name": "Lindsay Smith"
@@ -61,8 +62,8 @@
61
62
  "name": "Knowcode Ltd",
62
63
  "url": "https://knowcode.tech"
63
64
  },
64
- "datePublished": "2025-07-22T08:32:13.144Z",
65
- "dateModified": "2025-07-22T08:32:13.144Z",
65
+ "datePublished": "2025-07-22T11:08:52.142Z",
66
+ "dateModified": "2025-07-22T11:08:52.142Z",
66
67
  "mainEntityOfPage": {
67
68
  "@type": "WebPage",
68
69
  "@id": "https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html"
@@ -95,7 +96,7 @@
95
96
 
96
97
  <div class="header-actions">
97
98
  <div class="deployment-info">
98
- <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
+ <span class="deployment-date" title="Built with doc-builder v1.5.13">Last updated: Jul 22, 2025, 11:08 AM UTC</span>
99
100
  </div>
100
101
 
101
102
 
@@ -146,8 +147,8 @@
146
147
  <div class="nav-content" >
147
148
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
148
149
  <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>
149
- <a href="/vercel-cli-setup-guide.html" class="nav-item active" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
150
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
150
+ <a href="/vercel-cli-setup-guide.html" class="nav-item active" 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>
151
+ <a href="/vercel-first-time-setup-guide.html" class="nav-item" 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>
151
152
  <div class="nav-section" data-level="1">
152
153
  <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
153
154
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -157,6 +158,7 @@
157
158
  <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>
158
159
  <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>
159
160
  <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>
161
+ <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>
160
162
  <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>
161
163
  <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>
162
164
  <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></div></div>
@@ -168,14 +170,14 @@
168
170
  <main class="content">
169
171
  <div class="content-inner">
170
172
  <h1>Vercel CLI Setup Guide</h1>
171
- <p><strong>Generated</strong>: 2025-07-21 20:30 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
173
+ <p><strong>Generated</strong>: 2025-07-22 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
172
174
  <h2>Overview</h2>
173
- <p>This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments. The Vercel CLI enables you to deploy projects, manage deployments, and configure projects directly from your terminal.</p>
175
+ <p>This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems. While <code>@knowcode/doc-builder</code> handles most deployment complexity for you, understanding Vercel CLI installation and advanced features can be helpful for power users.</p>
174
176
  <h2>Prerequisites</h2>
175
177
  <ul>
176
- <li><strong>Node.js</strong>: Version 14.x or higher ✅</li>
177
- <li><strong>npm</strong> or <strong>yarn</strong>: Package manager ✅</li>
178
- <li><strong>Git</strong>: For version control (optional but recommended) ✅</li>
178
+ <li><strong>Node.js</strong>: Version 14.x or higher <i class="ph ph-check-circle" aria-label="checked"></i></li>
179
+ <li><strong>npm</strong> or <strong>yarn</strong>: Package manager <i class="ph ph-check-circle" aria-label="checked"></i></li>
180
+ <li><strong>Git</strong>: For version control (optional but recommended) <i class="ph ph-check-circle" aria-label="checked"></i></li>
179
181
  </ul>
180
182
  <h2>Installation Methods</h2>
181
183
  <h3>Method 1: npm (Recommended)</h3>
@@ -194,112 +196,114 @@
194
196
  <p><strong>Homebrew Formula</strong>: <a href="https://formulae.brew.sh/formula/vercel-cli">https://formulae.brew.sh/formula/vercel-cli</a></p>
195
197
  <h3>Method 5: Standalone Binary</h3>
196
198
  <p>Download directly from: <a href="https://vercel.com/download">https://vercel.com/download</a></p>
197
- <h2>Initial Setup</h2>
198
- <h3>1. Verify Installation</h3>
199
- <pre><code class="language-bash">vercel --version
199
+ <h2>Quick Start for doc-builder Users</h2>
200
+ <p>If you&#39;re using <code>@knowcode/doc-builder</code>, you only need to:</p>
201
+ <ol>
202
+ <li><p><strong>Install Vercel CLI</strong> (if not already installed):</p>
203
+ <pre><code class="language-bash">npm install -g vercel
200
204
  </code></pre>
201
- <h3>2. Login to Vercel</h3>
205
+ </li>
206
+ <li><p><strong>Login to Vercel</strong> (one-time setup):</p>
202
207
  <pre><code class="language-bash">vercel login
203
208
  </code></pre>
204
- <p>This will open your browser for authentication or provide email-based login options.</p>
205
- <p><strong>Authentication Guide</strong>: <a href="https://vercel.com/docs/cli#commands/login">https://vercel.com/docs/cli#commands/login</a></p>
206
- <h3>3. Check Authentication Status</h3>
207
- <pre><code class="language-bash">vercel whoami
209
+ </li>
210
+ <li><p><strong>Deploy with doc-builder</strong>:</p>
211
+ <pre><code class="language-bash">npx @knowcode/doc-builder deploy
208
212
  </code></pre>
209
- <h2>Configuration</h2>
210
- <h3>Global Configuration</h3>
213
+ </li>
214
+ </ol>
215
+ <p>That&#39;s it! doc-builder handles all the configuration for you.</p>
216
+ <h2>Detailed Installation Instructions</h2>
217
+ <h2>Understanding Vercel CLI</h2>
218
+ <h3>What Gets Installed</h3>
211
219
  <p>The Vercel CLI stores configuration in:</p>
212
220
  <ul>
213
221
  <li><strong>macOS/Linux</strong>: <code>~/.vercel/</code></li>
214
222
  <li><strong>Windows</strong>: <code>%USERPROFILE%\.vercel\</code></li>
215
223
  </ul>
216
- <p><strong>Configuration Documentation</strong>: <a href="https://vercel.com/docs/cli#configuration">https://vercel.com/docs/cli#configuration</a></p>
217
- <h3>Project Configuration</h3>
218
- <p>Create <code>vercel.json</code> in your project root:</p>
219
- <pre><code class="language-json">{
220
- &quot;version&quot;: 2,
221
- &quot;builds&quot;: [
222
- {
223
- &quot;src&quot;: &quot;package.json&quot;,
224
- &quot;use&quot;: &quot;@vercel/static-build&quot;
225
- }
226
- ],
227
- &quot;routes&quot;: [
228
- {
229
- &quot;src&quot;: &quot;/(.*)&quot;,
230
- &quot;dest&quot;: &quot;/$1&quot;
231
- }
232
- ]
233
- }
234
- </code></pre>
235
- <p><strong>Project Configuration Guide</strong>: <a href="https://vercel.com/docs/project-configuration">https://vercel.com/docs/project-configuration</a></p>
236
- <h2>Common Commands</h2>
237
- <h3>Deploy Commands</h3>
238
- <pre><code class="language-bash"># Deploy to preview
239
- vercel
224
+ <h3>Authentication</h3>
225
+ <pre><code class="language-bash"># Check who you&#39;re logged in as
226
+ vercel whoami
240
227
 
241
- # Deploy to production
242
- vercel --prod
228
+ # Log out
229
+ vercel logout
243
230
 
244
- # Deploy with specific name
245
- vercel --name my-project
231
+ # Log in again
232
+ vercel login
246
233
  </code></pre>
247
- <p><strong>Deployment Documentation</strong>: <a href="https://vercel.com/docs/cli#commands/deploy">https://vercel.com/docs/cli#commands/deploy</a></p>
234
+ <p><strong>Note</strong>: doc-builder automatically generates the necessary <code>vercel.json</code> configuration for you, so you don&#39;t need to create it manually.</p>
235
+ <h2>Advanced Vercel CLI Commands</h2>
236
+ <p>While doc-builder handles deployment, you might want to use these Vercel CLI commands directly:</p>
248
237
  <h3>Project Management</h3>
249
- <pre><code class="language-bash"># List all projects
238
+ <pre><code class="language-bash"># List your projects
250
239
  vercel project ls
251
240
 
252
- # Create new project
253
- vercel project add
241
+ # View project details
242
+ vercel project &lt;project-name&gt;
254
243
 
255
- # Remove project
244
+ # Remove a project
256
245
  vercel project rm &lt;project-name&gt;
257
246
  </code></pre>
258
- <p><strong>Project Commands</strong>: <a href="https://vercel.com/docs/cli#commands/project">https://vercel.com/docs/cli#commands/project</a></p>
247
+ <h3>Domain Management</h3>
248
+ <pre><code class="language-bash"># List domains
249
+ vercel domains ls
250
+
251
+ # Add a domain to a project
252
+ vercel domains add &lt;domain&gt; &lt;project&gt;
253
+
254
+ # Remove a domain
255
+ vercel domains rm &lt;domain&gt;
256
+ </code></pre>
257
+ <h3>Deployment Management</h3>
258
+ <pre><code class="language-bash"># List recent deployments
259
+ vercel ls
260
+
261
+ # Inspect a deployment
262
+ vercel inspect &lt;deployment-url&gt;
263
+
264
+ # Remove a deployment
265
+ vercel rm &lt;deployment-url&gt;
266
+ </code></pre>
259
267
  <h3>Environment Variables</h3>
260
268
  <pre><code class="language-bash"># Add environment variable
261
- vercel env add
269
+ vercel env add &lt;name&gt;
262
270
 
263
271
  # List environment variables
264
272
  vercel env ls
265
273
 
266
274
  # Remove environment variable
267
- vercel env rm &lt;variable-name&gt;
275
+ vercel env rm &lt;name&gt;
268
276
  </code></pre>
269
- <p><strong>Environment Variables Guide</strong>: <a href="https://vercel.com/docs/concepts/projects/environment-variables">https://vercel.com/docs/concepts/projects/environment-variables</a></p>
270
277
  <h2>Troubleshooting</h2>
271
- <h3>Common Issues</h3>
272
- <h4>1. Command Not Found</h4>
278
+ <h3>Common Installation Issues</h3>
279
+ <h4>Command Not Found</h4>
273
280
  <p>If <code>vercel</code> command is not found after installation:</p>
274
- <p><strong>Solution</strong>: Add npm global bin to PATH</p>
275
- <pre><code class="language-bash"># Find npm bin location
281
+ <pre><code class="language-bash"># Find npm global bin location
276
282
  npm bin -g
277
283
 
278
- # Add to PATH (bash/zsh)
284
+ # Add to PATH (add to your ~/.bashrc or ~/.zshrc)
279
285
  export PATH=&quot;$(npm bin -g):$PATH&quot;
280
286
  </code></pre>
281
- <p><strong>PATH Configuration Guide</strong>: <a href="https://vercel.com/docs/cli#installation/troubleshooting">https://vercel.com/docs/cli#installation/troubleshooting</a></p>
282
- <h4>2. Authentication Issues</h4>
283
- <p>If login fails or tokens expire:</p>
284
- <pre><code class="language-bash"># Logout and login again
287
+ <h4>Permission Errors</h4>
288
+ <p>If you get EACCES errors during installation:</p>
289
+ <pre><code class="language-bash"># Option 1: Use npx instead (recommended)
290
+ npx vercel
291
+
292
+ # Option 2: Fix npm permissions
293
+ # See: https://docs.npmjs.com/resolving-eacces-permissions-errors
294
+
295
+ # Option 3: Use a Node version manager like nvm
296
+ # See: https://github.com/nvm-sh/nvm
297
+ </code></pre>
298
+ <h4>Authentication Issues</h4>
299
+ <pre><code class="language-bash"># If login fails, try:
285
300
  vercel logout
286
301
  vercel login
287
- </code></pre>
288
- <p><strong>Authentication Troubleshooting</strong>: <a href="https://vercel.com/docs/cli#authentication/troubleshooting">https://vercel.com/docs/cli#authentication/troubleshooting</a></p>
289
- <h4>3. Permission Errors</h4>
290
- <p>For npm permission errors during global install:</p>
291
- <p><strong>Option 1</strong>: Use npm&#39;s official guide<br><a href="https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally">https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally</a></p>
292
- <p><strong>Option 2</strong>: Use Node Version Manager (nvm)<br><a href="https://github.com/nvm-sh/nvm">https://github.com/nvm-sh/nvm</a></p>
293
- <h4>4. Proxy Configuration</h4>
294
- <p>For corporate environments:</p>
295
- <pre><code class="language-bash"># Set proxy
296
- vercel --proxy http://proxy.company.com:8080
297
302
 
298
- # Or use environment variables
303
+ # For corporate proxies:
299
304
  export HTTP_PROXY=http://proxy.company.com:8080
300
305
  export HTTPS_PROXY=http://proxy.company.com:8080
301
306
  </code></pre>
302
- <p><strong>Proxy Documentation</strong>: <a href="https://vercel.com/docs/cli#using-behind-a-proxy">https://vercel.com/docs/cli#using-behind-a-proxy</a></p>
303
307
  <h2>Platform-Specific Instructions</h2>
304
308
  <h3>macOS</h3>
305
309
  <ol>
@@ -344,107 +348,44 @@ sudo pacman -S nodejs npm
344
348
  </li>
345
349
  </ol>
346
350
  <p><strong>Linux Guide</strong>: <a href="https://vercel.com/docs/cli#linux-installation">https://vercel.com/docs/cli#linux-installation</a></p>
347
- <h2>CI/CD Integration</h2>
348
- <h3>GitHub Actions</h3>
349
- <pre><code class="language-yaml">- name: Install Vercel CLI
350
- run: npm install -g vercel
351
-
352
- - name: Deploy to Vercel
353
- run: vercel --prod --token=${{ secrets.VERCEL_TOKEN }}
354
- </code></pre>
355
- <p><strong>GitHub Actions Guide</strong>: <a href="https://vercel.com/guides/how-can-i-use-github-actions-with-vercel">https://vercel.com/guides/how-can-i-use-github-actions-with-vercel</a></p>
356
- <h3>GitLab CI</h3>
357
- <pre><code class="language-yaml">deploy:
358
- script:
359
- - npm install -g vercel
360
- - vercel --prod --token=$VERCEL_TOKEN
361
- </code></pre>
362
- <p><strong>GitLab CI Guide</strong>: <a href="https://vercel.com/docs/concepts/deployments/git/gitlab">https://vercel.com/docs/concepts/deployments/git/gitlab</a></p>
363
- <h2>Advanced Configuration</h2>
364
- <h3>Custom Build Commands</h3>
365
- <pre><code class="language-json">{
366
- &quot;buildCommand&quot;: &quot;npm run build&quot;,
367
- &quot;outputDirectory&quot;: &quot;dist&quot;,
368
- &quot;devCommand&quot;: &quot;npm run dev&quot;
369
- }
370
- </code></pre>
371
- <h3>Monorepo Support</h3>
372
- <pre><code class="language-bash"># Deploy from subdirectory
373
- vercel --cwd ./apps/web
351
+ <h2>Using Vercel CLI with doc-builder</h2>
352
+ <h3>Deploying to Production</h3>
353
+ <p>While doc-builder handles deployment, you can also use Vercel CLI directly:</p>
354
+ <pre><code class="language-bash"># From your html output directory
355
+ cd html
356
+ vercel --prod
374
357
  </code></pre>
375
- <p><strong>Monorepo Guide</strong>: <a href="https://vercel.com/docs/concepts/monorepos">https://vercel.com/docs/concepts/monorepos</a></p>
376
- <h3>Team Collaboration</h3>
377
- <pre><code class="language-bash"># Switch team context
358
+ <h3>Working with Teams</h3>
359
+ <pre><code class="language-bash"># Switch between personal and team accounts
378
360
  vercel switch
379
361
 
380
- # Invite team member
381
- vercel team invite &lt;email&gt;
362
+ # Deploy to a specific team
363
+ vercel --scope team-name
382
364
  </code></pre>
383
- <p><strong>Team Management</strong>: <a href="https://vercel.com/docs/cli#commands/teams">https://vercel.com/docs/cli#commands/teams</a></p>
384
- <h2>Security Best Practices</h2>
385
- <h3>1. Token Management</h3>
386
- <ul>
387
- <li><strong>Never commit tokens</strong> to version control ✅</li>
388
- <li><strong>Use environment variables</strong> for CI/CD ✅</li>
389
- <li><strong>Rotate tokens regularly</strong> ✅</li>
390
- </ul>
391
- <p><strong>Security Guide</strong>: <a href="https://vercel.com/docs/security">https://vercel.com/docs/security</a></p>
392
- <h3>2. Scoped Tokens</h3>
393
- <p>Create scoped tokens for specific projects:<br><a href="https://vercel.com/account/tokens">https://vercel.com/account/tokens</a></p>
394
- <h3>3. Two-Factor Authentication</h3>
395
- <p>Enable 2FA on your Vercel account:<br><a href="https://vercel.com/docs/accounts/team-members/two-factor-authentication">https://vercel.com/docs/accounts/team-members/two-factor-authentication</a></p>
396
- <h2>Additional Resources</h2>
365
+ <h3>CI/CD Integration</h3>
366
+ <p>For automated deployments:</p>
367
+ <pre><code class="language-yaml"># GitHub Actions example
368
+ - name: Deploy Documentation
369
+ run: |
370
+ npm install -g @knowcode/doc-builder vercel
371
+ doc-builder build
372
+ vercel --prod --token=${{ secrets.VERCEL_TOKEN }}
373
+ </code></pre>
374
+ <h2>Key Resources</h2>
397
375
  <h3>Official Documentation</h3>
398
376
  <ul>
399
- <li><strong>Main CLI Documentation</strong>: <a href="https://vercel.com/docs/cli">https://vercel.com/docs/cli</a></li>
400
- <li><strong>API Reference</strong>: <a href="https://vercel.com/docs/rest-api">https://vercel.com/docs/rest-api</a></li>
401
- <li><strong>Examples Repository</strong>: <a href="https://github.com/vercel/examples">https://github.com/vercel/examples</a></li>
402
- </ul>
403
- <h3>Community Resources</h3>
404
- <ul>
405
- <li><strong>Discord Community</strong>: <a href="https://vercel.com/discord">https://vercel.com/discord</a></li>
406
- <li><strong>GitHub Discussions</strong>: <a href="https://github.com/vercel/vercel/discussions">https://github.com/vercel/vercel/discussions</a></li>
407
- <li><strong>Stack Overflow</strong>: <a href="https://stackoverflow.com/questions/tagged/vercel">https://stackoverflow.com/questions/tagged/vercel</a></li>
408
- </ul>
409
- <h3>Video Tutorials</h3>
410
- <ul>
411
- <li><strong>Official YouTube Channel</strong>: <a href="https://www.youtube.com/c/VercelHQ">https://www.youtube.com/c/VercelHQ</a></li>
412
- <li><strong>Getting Started Playlist</strong>: <a href="https://vercel.com/docs/getting-started-with-vercel">https://vercel.com/docs/getting-started-with-vercel</a></li>
413
- </ul>
414
- <h2>Version History</h2>
415
- <table>
416
- <thead>
417
- <tr>
418
- <th>Version</th>
419
- <th>Release Date</th>
420
- <th>Notes</th>
421
- </tr>
422
- </thead>
423
- <tbody><tr>
424
- <td>Latest</td>
425
- <td>Check npm</td>
426
- <td><a href="https://www.npmjs.com/package/vercel">https://www.npmjs.com/package/vercel</a></td>
427
- </tr>
428
- <tr>
429
- <td>Changelog</td>
430
- <td>All versions</td>
431
- <td><a href="https://github.com/vercel/vercel/releases">https://github.com/vercel/vercel/releases</a></td>
432
- </tr>
433
- </tbody></table>
434
- <h2>Support</h2>
435
- <h3>Getting Help</h3>
436
- <ul>
437
- <li><strong>Documentation</strong>: <a href="https://vercel.com/docs">https://vercel.com/docs</a></li>
438
- <li><strong>Support Portal</strong>: <a href="https://vercel.com/support">https://vercel.com/support</a></li>
439
- <li><strong>Status Page</strong>: <a href="https://www.vercel-status.com/">https://www.vercel-status.com/</a></li>
377
+ <li><strong>Vercel CLI Docs</strong>: <a href="https://vercel.com/docs/cli">https://vercel.com/docs/cli</a></li>
378
+ <li><strong>Vercel Dashboard</strong>: <a href="https://vercel.com/dashboard">https://vercel.com/dashboard</a></li>
379
+ <li><strong>Support</strong>: <a href="https://vercel.com/support">https://vercel.com/support</a></li>
440
380
  </ul>
441
- <h3>Reporting Issues</h3>
381
+ <h3>For doc-builder Users</h3>
442
382
  <ul>
443
- <li><strong>GitHub Issues</strong>: <a href="https://github.com/vercel/vercel/issues">https://github.com/vercel/vercel/issues</a></li>
444
- <li><strong>Feature Requests</strong>: <a href="https://github.com/vercel/vercel/discussions/categories/ideas">https://github.com/vercel/vercel/discussions/categories/ideas</a></li>
383
+ <li><strong>First-Time Setup Guide</strong>: <a href="./vercel-first-time-setup-guide.md">vercel-first-time-setup-guide.md</a></li>
384
+ <li><strong>Troubleshooting Guide</strong>: <a href="./troubleshooting-guide.md">troubleshooting-guide.md</a></li>
385
+ <li><strong>doc-builder Documentation</strong>: <a href="https://www.npmjs.com/package/@knowcode/doc-builder">https://www.npmjs.com/package/@knowcode/doc-builder</a></li>
445
386
  </ul>
446
387
  <hr>
447
- <p>This guide provides comprehensive coverage of Vercel CLI setup and configuration. For the most up-to-date information, always refer to the official Vercel documentation at <a href="https://vercel.com/docs">https://vercel.com/docs</a>.</p>
388
+ <p>This guide covers Vercel CLI installation and advanced usage. For most doc-builder users, the simplified deployment process handles everything automatically. See the <a href="./vercel-first-time-setup-guide.md">First-Time Setup Guide</a> for the streamlined deployment experience.</p>
448
389
 
449
390
  </div>
450
391
  </main>