@knowcode/doc-builder 1.5.11 → 1.5.13
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/CHANGELOG.md +37 -0
- package/README.md +13 -12
- package/doc-builder.config.js +2 -1
- package/html/README.html +25 -24
- package/html/documentation-index.html +10 -9
- package/html/guides/authentication-guide.html +19 -18
- package/html/guides/claude-workflow-guide.html +24 -23
- package/html/guides/documentation-standards.html +21 -20
- package/html/guides/google-site-verification-guide.html +6 -5
- package/html/guides/seo-guide.html +10 -9
- package/html/guides/seo-optimization-guide.html +39 -38
- package/html/guides/troubleshooting-guide.html +39 -28
- package/html/index.html +25 -24
- package/html/sitemap.xml +15 -15
- package/html/vercel-cli-setup-guide.html +114 -174
- package/html/vercel-first-time-setup-guide.html +134 -217
- package/lib/config.js +8 -2
- package/lib/core-builder.js +7 -2
- package/lib/emoji-mapper.js +267 -0
- package/package.json +1 -1
|
@@ -3,19 +3,19 @@
|
|
|
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-
|
|
7
|
-
<title>Vercel First-Time Setup Guide -
|
|
6
|
+
<meta name="description" content="Generated: 2025-07-22 UTC">
|
|
7
|
+
<title>Vercel First-Time Setup Guide - Simplified Process</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style,
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, deployment">
|
|
11
11
|
<meta name="robots" content="index, follow">
|
|
12
12
|
<link rel="canonical" href="https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html">
|
|
13
13
|
|
|
14
14
|
<!-- Open Graph / Facebook -->
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html">
|
|
17
|
-
<meta property="og:title" content="Vercel First-Time Setup Guide -
|
|
18
|
-
<meta property="og:description" content="Generated: 2025-07-
|
|
17
|
+
<meta property="og:title" content="Vercel First-Time Setup Guide - Simplified Process">
|
|
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">
|
|
@@ -24,8 +24,8 @@
|
|
|
24
24
|
<meta name="twitter:card" content="summary_large_image">
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Vercel First-Time Setup Guide -
|
|
28
|
-
<meta name="twitter:description" content="Generated: 2025-07-
|
|
27
|
+
<meta name="twitter:title" content="Vercel First-Time Setup Guide - Simplified Process">
|
|
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>
|
|
@@ -50,8 +51,8 @@
|
|
|
50
51
|
{
|
|
51
52
|
"@context": "https://schema.org",
|
|
52
53
|
"@type": "TechArticle",
|
|
53
|
-
"headline": "Vercel First-Time Setup Guide -
|
|
54
|
-
"description": "Generated: 2025-07-
|
|
54
|
+
"headline": "Vercel First-Time Setup Guide - Simplified Process",
|
|
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-
|
|
65
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T11:03:54.353Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:03:54.353Z",
|
|
66
67
|
"mainEntityOfPage": {
|
|
67
68
|
"@type": "WebPage",
|
|
68
69
|
"@id": "https://doc-builder-delta.vercel.app/vercel-first-time-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.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 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" data-tooltip="This guide provides comprehensive instructions for installing
|
|
150
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item active" data-tooltip="This guide
|
|
150
|
+
<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>
|
|
151
|
+
<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>
|
|
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
|
|
@@ -167,251 +168,167 @@
|
|
|
167
168
|
<!-- Content Area -->
|
|
168
169
|
<main class="content">
|
|
169
170
|
<div class="content-inner">
|
|
170
|
-
<h1>Vercel First-Time Setup Guide -
|
|
171
|
-
<p><strong>Generated</strong>: 2025-07-
|
|
171
|
+
<h1>Vercel First-Time Setup Guide - Simplified Process</h1>
|
|
172
|
+
<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
173
|
<h2>Overview</h2>
|
|
173
|
-
<p>This guide
|
|
174
|
-
<h2>
|
|
175
|
-
<
|
|
176
|
-
<
|
|
174
|
+
<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>
|
|
175
|
+
<h2>The Simplified Process</h2>
|
|
176
|
+
<h3>Step 1: Run the Deploy Command</h3>
|
|
177
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder deploy
|
|
178
|
+
</code></pre>
|
|
179
|
+
<h3>Step 2: doc-builder Configuration</h3>
|
|
180
|
+
<p>The tool will ask a few simple questions:</p>
|
|
181
|
+
<h4>Project Name</h4>
|
|
177
182
|
<pre><code>? What is your project name? › my-docs
|
|
178
183
|
</code></pre>
|
|
179
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
180
184
|
<ul>
|
|
181
185
|
<li>This becomes your Vercel project identifier</li>
|
|
182
|
-
<li>
|
|
183
|
-
<li>
|
|
184
|
-
<li>Auto-generated from your site name with special characters removed</li>
|
|
185
|
-
</ul>
|
|
186
|
-
<p><strong>Best practice</strong>: </p>
|
|
187
|
-
<ul>
|
|
188
|
-
<li>Keep it short and memorable</li>
|
|
189
|
-
<li>Use hyphens instead of spaces</li>
|
|
190
|
-
<li>Example: <code>my-docs</code>, <code>company-docs</code>, <code>api-reference</code></li>
|
|
186
|
+
<li>Will be part of your URL: <code>project-name.vercel.app</code></li>
|
|
187
|
+
<li>Use lowercase letters, numbers, and hyphens only</li>
|
|
191
188
|
</ul>
|
|
192
|
-
<
|
|
189
|
+
<h4>Custom Production URL (Optional)</h4>
|
|
193
190
|
<pre><code>? Custom production URL (optional)? ›
|
|
194
191
|
</code></pre>
|
|
195
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
196
|
-
<ul>
|
|
197
|
-
<li>Leave empty for auto-detection (recommended for new projects)</li>
|
|
198
|
-
<li>Or enter your custom domain/alias if you already have one</li>
|
|
199
|
-
<li>Can be a full URL or just the domain</li>
|
|
200
|
-
</ul>
|
|
201
|
-
<p><strong>Examples</strong>:</p>
|
|
202
|
-
<ul>
|
|
203
|
-
<li>Empty (press Enter) - Vercel will auto-assign</li>
|
|
204
|
-
<li><code>docs.mycompany.com</code> - Custom domain</li>
|
|
205
|
-
<li><code>my-docs-v2.vercel.app</code> - Specific Vercel subdomain</li>
|
|
206
|
-
</ul>
|
|
207
|
-
<h3>3. Framework Preset</h3>
|
|
208
|
-
<pre><code>? Which framework preset? › - Use arrow-keys. Return to submit.
|
|
209
|
-
❯ Other (Static HTML)
|
|
210
|
-
Next.js
|
|
211
|
-
Vite
|
|
212
|
-
</code></pre>
|
|
213
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
214
|
-
<ul>
|
|
215
|
-
<li>Determines build settings and optimizations</li>
|
|
216
|
-
<li><strong>ALWAYS choose "Other (Static HTML)"</strong> for doc-builder</li>
|
|
217
|
-
<li>This ensures Vercel treats your docs as pre-built static files</li>
|
|
218
|
-
</ul>
|
|
219
|
-
<p><strong>Why this matters</strong>:</p>
|
|
220
|
-
<ul>
|
|
221
|
-
<li>Wrong selection can trigger unwanted build processes</li>
|
|
222
|
-
<li>May cause deployment failures or missing files</li>
|
|
223
|
-
</ul>
|
|
224
|
-
<h3>4. Public Access</h3>
|
|
225
|
-
<pre><code>? Make the deployment publicly accessible? › (Y/n)
|
|
226
|
-
</code></pre>
|
|
227
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
228
|
-
<ul>
|
|
229
|
-
<li><strong>Yes (Y)</strong>: Anyone with the URL can view your docs</li>
|
|
230
|
-
<li><strong>No (n)</strong>: Only team members can access (requires Vercel login)</li>
|
|
231
|
-
</ul>
|
|
232
|
-
<p><strong>Considerations</strong>:</p>
|
|
233
|
-
<ul>
|
|
234
|
-
<li>Choose Yes for public documentation</li>
|
|
235
|
-
<li>Choose No for internal/private docs</li>
|
|
236
|
-
<li>Can be changed later in Vercel dashboard</li>
|
|
237
|
-
</ul>
|
|
238
|
-
<h2>Vercel CLI Link Process</h2>
|
|
239
|
-
<p>After the initial configuration, Vercel CLI takes over with its own prompts:</p>
|
|
240
|
-
<h3>5. Directory Confirmation</h3>
|
|
241
|
-
<pre><code>? Set up and deploy "~/Documents/.../html"? [Y/n]
|
|
242
|
-
</code></pre>
|
|
243
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
244
|
-
<ul>
|
|
245
|
-
<li>Vercel is asking to deploy from the current directory</li>
|
|
246
|
-
<li>This should show your <code>html</code> output directory path</li>
|
|
247
|
-
<li><strong>ALWAYS answer YES</strong></li>
|
|
248
|
-
</ul>
|
|
249
|
-
<p><strong>Common mistake</strong>: </p>
|
|
250
192
|
<ul>
|
|
251
|
-
<li>
|
|
252
|
-
<li>
|
|
193
|
+
<li>Press Enter to skip (recommended for first-time setup)</li>
|
|
194
|
+
<li>Or enter your custom domain if you have one</li>
|
|
253
195
|
</ul>
|
|
254
|
-
<h3>
|
|
255
|
-
<
|
|
256
|
-
|
|
257
|
-
|
|
196
|
+
<h3>Step 3: Vercel CLI Takes Over</h3>
|
|
197
|
+
<p>The new Vercel CLI experience is much simpler with clearer prompts:</p>
|
|
198
|
+
<h4>Deploy Confirmation</h4>
|
|
199
|
+
<pre><code>Vercel CLI 28.0.0
|
|
200
|
+
? Set up and deploy "~/path/to/your/project/html"? [Y/n]
|
|
258
201
|
</code></pre>
|
|
259
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
260
202
|
<ul>
|
|
261
|
-
<li>
|
|
262
|
-
<li>
|
|
263
|
-
<li>Team accounts show as "Team Name (team-slug)"</li>
|
|
264
|
-
<li><strong>Select your personal account for individual projects</strong></li>
|
|
203
|
+
<li>Answer <strong>Yes</strong> to proceed</li>
|
|
204
|
+
<li>This confirms you want to deploy the current directory</li>
|
|
265
205
|
</ul>
|
|
266
|
-
<
|
|
267
|
-
<
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
<li>Shared billing and permissions</li>
|
|
271
|
-
</ul>
|
|
272
|
-
<h3>7. Existing Project Detection</h3>
|
|
273
|
-
<pre><code>? Found project "lindsay-1340s-projects/html". Link to it? [Y/n]
|
|
206
|
+
<h4>Account Selection</h4>
|
|
207
|
+
<pre><code>? Which scope do you want to deploy to? ›
|
|
208
|
+
○ Your Name
|
|
209
|
+
○ Your Team (if applicable)
|
|
274
210
|
</code></pre>
|
|
275
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
276
211
|
<ul>
|
|
277
|
-
<li>
|
|
278
|
-
<li>
|
|
279
|
-
<li><strong>ALWAYS answer NO unless you're 100% sure it's YOUR project</strong></li>
|
|
212
|
+
<li>Select your personal account or team</li>
|
|
213
|
+
<li>Use arrow keys to navigate, Enter to select</li>
|
|
280
214
|
</ul>
|
|
281
|
-
<
|
|
282
|
-
<
|
|
283
|
-
<li>Vercel searches for projects with matching directory names</li>
|
|
284
|
-
<li>Common folder names (html, docs, dist) often match other projects</li>
|
|
285
|
-
<li>The suggested project usually belongs to someone else</li>
|
|
286
|
-
</ul>
|
|
287
|
-
<h3>8. Link to Different Project</h3>
|
|
288
|
-
<pre><code>? Link to different existing project? [Y/n]
|
|
215
|
+
<h4>Project Name Confirmation</h4>
|
|
216
|
+
<pre><code>? What's your project's name? (my-docs)
|
|
289
217
|
</code></pre>
|
|
290
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
291
|
-
<ul>
|
|
292
|
-
<li><strong>Yes (Y)</strong>: You have an existing Vercel project to connect to</li>
|
|
293
|
-
<li><strong>No (n)</strong>: Create a brand new project</li>
|
|
294
|
-
</ul>
|
|
295
|
-
<p><strong>When to answer YES</strong>:</p>
|
|
296
|
-
<ul>
|
|
297
|
-
<li>You've deployed before and want to update existing project</li>
|
|
298
|
-
<li>You created a project in Vercel dashboard first</li>
|
|
299
|
-
<li>You're reconnecting after deleting <code>.vercel</code> folder</li>
|
|
300
|
-
</ul>
|
|
301
|
-
<p><strong>When to answer NO</strong>:</p>
|
|
302
218
|
<ul>
|
|
303
|
-
<li>
|
|
304
|
-
<li>
|
|
305
|
-
<li>Previous project had configuration issues</li>
|
|
219
|
+
<li>Vercel suggests the name you provided earlier</li>
|
|
220
|
+
<li>Press Enter to accept or type a new name</li>
|
|
306
221
|
</ul>
|
|
307
|
-
<
|
|
308
|
-
<pre><code>?
|
|
222
|
+
<h4>Framework Detection</h4>
|
|
223
|
+
<pre><code>? In which directory is your code located? ./
|
|
309
224
|
</code></pre>
|
|
310
|
-
<p><strong>What it means</strong>: ✅</p>
|
|
311
225
|
<ul>
|
|
312
|
-
<li>
|
|
313
|
-
<li>
|
|
314
|
-
<li>
|
|
226
|
+
<li>Vercel automatically detects this is a static site</li>
|
|
227
|
+
<li>Usually defaults to <code>./</code> which is correct</li>
|
|
228
|
+
<li>Press Enter to accept</li>
|
|
315
229
|
</ul>
|
|
316
|
-
<
|
|
230
|
+
<h3>Step 4: Deployment Begins</h3>
|
|
231
|
+
<p>That's it! Vercel will now:</p>
|
|
317
232
|
<ol>
|
|
318
|
-
<li>
|
|
319
|
-
<li>
|
|
320
|
-
<li>
|
|
233
|
+
<li>Upload your files</li>
|
|
234
|
+
<li>Deploy to their global CDN</li>
|
|
235
|
+
<li>Provide your live URL</li>
|
|
321
236
|
</ol>
|
|
322
|
-
<
|
|
323
|
-
<pre><code>? What is your project name? › my-docs
|
|
237
|
+
<pre><code><i class="ph ph-check" aria-label="check"></i> Production: https://my-docs.vercel.app [copied to clipboard]
|
|
324
238
|
</code></pre>
|
|
325
|
-
<
|
|
326
|
-
<
|
|
327
|
-
<
|
|
328
|
-
<li>Will become your default URL: <code>project-name.vercel.app</code></li>
|
|
329
|
-
<li>Must be unique across all Vercel projects</li>
|
|
330
|
-
</ul>
|
|
331
|
-
<p><strong>Best practices</strong>:</p>
|
|
239
|
+
<h2>What Changed from the Old Process?</h2>
|
|
240
|
+
<p>The new Vercel CLI is much simpler:</p>
|
|
241
|
+
<h3>Removed Prompts</h3>
|
|
332
242
|
<ul>
|
|
333
|
-
<li>
|
|
334
|
-
<li>
|
|
335
|
-
<li>
|
|
243
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> No more "Found project xyz/html. Link to it?" confusion</li>
|
|
244
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> No more "Link to different existing project?" complexity</li>
|
|
245
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> No more manual framework selection (auto-detected)</li>
|
|
246
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> No more "Make deployment publicly accessible?" (configured later)</li>
|
|
336
247
|
</ul>
|
|
337
|
-
<
|
|
338
|
-
<h3>Root Directory Warning</h3>
|
|
339
|
-
<p>After linking, you may see an error about "html/html does not exist". This means Vercel incorrectly set the Root Directory.</p>
|
|
340
|
-
<p><strong>The Problem</strong>: ❌</p>
|
|
248
|
+
<h3>Improved Experience</h3>
|
|
341
249
|
<ul>
|
|
342
|
-
<li
|
|
343
|
-
<li
|
|
344
|
-
<li
|
|
250
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Clearer prompts with better wording</li>
|
|
251
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Automatic framework detection</li>
|
|
252
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Fewer steps overall</li>
|
|
253
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Less chance for configuration errors</li>
|
|
345
254
|
</ul>
|
|
346
|
-
<
|
|
255
|
+
<h2>Post-Deployment Configuration</h2>
|
|
256
|
+
<h3>Making Your Docs Public</h3>
|
|
257
|
+
<p>By default, Vercel may protect your deployment. To make docs publicly accessible:</p>
|
|
347
258
|
<ol>
|
|
348
|
-
<li>Go to your
|
|
349
|
-
<li>
|
|
350
|
-
<li
|
|
351
|
-
<li>
|
|
259
|
+
<li>Go to your <a href="https://vercel.com/dashboard">Vercel Dashboard</a></li>
|
|
260
|
+
<li>Click on your project</li>
|
|
261
|
+
<li>Navigate to <strong>Settings → Deployment Protection</strong></li>
|
|
262
|
+
<li>Set <strong>Vercel Authentication</strong> to <strong>Disabled</strong></li>
|
|
263
|
+
<li>Click <strong>Save</strong></li>
|
|
352
264
|
</ol>
|
|
353
|
-
<h3>
|
|
354
|
-
<p>
|
|
355
|
-
<
|
|
356
|
-
<
|
|
357
|
-
<li
|
|
358
|
-
<li
|
|
359
|
-
|
|
360
|
-
<
|
|
361
|
-
|
|
362
|
-
<p><strong>If any have values</strong>:</p>
|
|
265
|
+
<h3>Custom Domain (Optional)</h3>
|
|
266
|
+
<p>To add a custom domain:</p>
|
|
267
|
+
<ol>
|
|
268
|
+
<li>Go to <strong>Settings → Domains</strong></li>
|
|
269
|
+
<li>Add your domain</li>
|
|
270
|
+
<li>Follow DNS configuration instructions</li>
|
|
271
|
+
</ol>
|
|
272
|
+
<h3>Environment Variables (If Using Authentication)</h3>
|
|
273
|
+
<p>If you enabled authentication in doc-builder:</p>
|
|
363
274
|
<ol>
|
|
364
|
-
<li>
|
|
365
|
-
<li>
|
|
366
|
-
<li>Redeploy</li>
|
|
275
|
+
<li>Go to <strong>Settings → Environment Variables</strong></li>
|
|
276
|
+
<li>Add your auth credentials</li>
|
|
277
|
+
<li>Redeploy to apply changes</li>
|
|
367
278
|
</ol>
|
|
368
|
-
<h2>
|
|
369
|
-
<
|
|
279
|
+
<h2>Troubleshooting</h2>
|
|
280
|
+
<h3>"Vercel CLI not found"</h3>
|
|
281
|
+
<p>If you see this error, install Vercel CLI:</p>
|
|
282
|
+
<pre><code class="language-bash">npm install -g vercel
|
|
283
|
+
</code></pre>
|
|
284
|
+
<h3>"404 Not Found" After Deployment</h3>
|
|
285
|
+
<p>Make sure you:</p>
|
|
286
|
+
<ol>
|
|
287
|
+
<li>Ran the deploy command from your project root</li>
|
|
288
|
+
<li>Have markdown files in your <code>docs/</code> folder</li>
|
|
289
|
+
<li>Didn't modify the build output</li>
|
|
290
|
+
</ol>
|
|
291
|
+
<h3>"Authentication Required" Error</h3>
|
|
292
|
+
<p>Your deployment is protected. Follow the "Making Your Docs Public" steps above.</p>
|
|
293
|
+
<h3>Deployment Fails</h3>
|
|
294
|
+
<p>Check that:</p>
|
|
370
295
|
<ol>
|
|
371
|
-
<li>
|
|
372
|
-
<li>
|
|
373
|
-
<li>
|
|
374
|
-
<li>Or configure password protection if needed</li>
|
|
296
|
+
<li>You're using the latest version: <code>npx @knowcode/doc-builder@latest deploy</code></li>
|
|
297
|
+
<li>Your <code>docs/</code> folder contains <code>.md</code> files</li>
|
|
298
|
+
<li>You have internet connection</li>
|
|
375
299
|
</ol>
|
|
376
|
-
<h2>
|
|
377
|
-
<
|
|
378
|
-
<
|
|
379
|
-
<
|
|
380
|
-
<
|
|
381
|
-
<
|
|
382
|
-
<
|
|
383
|
-
<
|
|
384
|
-
<p><strong>Cause</strong>: Not logged into Vercel<br><strong>Solution</strong>: Run <code>vercel login</code> first</p>
|
|
385
|
-
<h2>Quick Reference Checklist</h2>
|
|
386
|
-
<pre><code>✅ 1. Project name? → your-project-name
|
|
387
|
-
✅ 2. Custom URL? → [Leave empty or enter domain]
|
|
388
|
-
✅ 3. Framework? → Other (Static HTML)
|
|
389
|
-
✅ 4. Public? → Yes (for public docs)
|
|
390
|
-
✅ 5. Set up ~/html? → YES
|
|
391
|
-
✅ 6. Which scope? → Your account
|
|
392
|
-
✅ 7. Found project "xyz/html"? → NO
|
|
393
|
-
✅ 8. Link to different project? → YES/NO (your choice)
|
|
394
|
-
✅ 9. Project name? → [Based on #8 answer]
|
|
395
|
-
✅ 10. Check Root Directory → Must be EMPTY
|
|
300
|
+
<h2>Quick Checklist</h2>
|
|
301
|
+
<pre><code><i class="ph ph-check-circle" aria-label="checked"></i> 1. Run: npx @knowcode/doc-builder deploy
|
|
302
|
+
<i class="ph ph-check-circle" aria-label="checked"></i> 2. Enter project name (e.g., my-docs)
|
|
303
|
+
<i class="ph ph-check-circle" aria-label="checked"></i> 3. Skip custom URL (press Enter)
|
|
304
|
+
<i class="ph ph-check-circle" aria-label="checked"></i> 4. Confirm deployment when Vercel asks
|
|
305
|
+
<i class="ph ph-check-circle" aria-label="checked"></i> 5. Select your account/scope
|
|
306
|
+
<i class="ph ph-check-circle" aria-label="checked"></i> 6. Accept suggested project name
|
|
307
|
+
<i class="ph ph-check-circle" aria-label="checked"></i> 7. Get your live URL!
|
|
396
308
|
</code></pre>
|
|
397
|
-
<h2>
|
|
309
|
+
<h2>Best Practices</h2>
|
|
398
310
|
<ol>
|
|
399
|
-
<li><strong>
|
|
400
|
-
<li><strong>
|
|
401
|
-
<li><strong>
|
|
402
|
-
<li><strong>
|
|
403
|
-
<li><strong>Keep it simple</strong>: Don't add build commands for static sites</li>
|
|
311
|
+
<li><strong>First Time</strong>: Just accept all defaults</li>
|
|
312
|
+
<li><strong>Project Names</strong>: Use descriptive names like <code>company-api-docs</code></li>
|
|
313
|
+
<li><strong>Custom Domains</strong>: Add them after successful deployment</li>
|
|
314
|
+
<li><strong>Updates</strong>: Future deploys are even simpler - just run the same command</li>
|
|
404
315
|
</ol>
|
|
405
316
|
<h2>Next Steps</h2>
|
|
406
|
-
<p>After successful
|
|
317
|
+
<p>After successful deployment:</p>
|
|
407
318
|
<ol>
|
|
408
|
-
<li>
|
|
409
|
-
<li>
|
|
410
|
-
<li>Add custom domain
|
|
411
|
-
<li>
|
|
319
|
+
<li>Visit your live docs at the provided URL</li>
|
|
320
|
+
<li>Make your docs public in Vercel settings if needed</li>
|
|
321
|
+
<li>Add a custom domain if desired</li>
|
|
322
|
+
<li>Share your documentation with the world!</li>
|
|
412
323
|
</ol>
|
|
324
|
+
<h2>Getting Help</h2>
|
|
325
|
+
<ul>
|
|
326
|
+
<li><strong>Vercel Dashboard</strong>: <a href="https://vercel.com/dashboard">https://vercel.com/dashboard</a></li>
|
|
327
|
+
<li><strong>Vercel Support</strong>: <a href="https://vercel.com/support">https://vercel.com/support</a></li>
|
|
328
|
+
<li><strong>doc-builder Issues</strong>: File on GitHub or npm</li>
|
|
329
|
+
</ul>
|
|
413
330
|
<hr>
|
|
414
|
-
<p>This guide
|
|
331
|
+
<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>
|
|
415
332
|
|
|
416
333
|
</div>
|
|
417
334
|
</main>
|
package/lib/config.js
CHANGED
|
@@ -21,7 +21,10 @@ const defaultConfig = {
|
|
|
21
21
|
mermaid: true,
|
|
22
22
|
tooltips: true,
|
|
23
23
|
search: false,
|
|
24
|
-
darkMode: true
|
|
24
|
+
darkMode: true,
|
|
25
|
+
phosphorIcons: true,
|
|
26
|
+
phosphorWeight: 'regular', // Options: thin, light, regular, bold, fill, duotone
|
|
27
|
+
phosphorSize: '1.2em' // Relative to text size
|
|
25
28
|
},
|
|
26
29
|
|
|
27
30
|
// Authentication (if enabled)
|
|
@@ -86,7 +89,10 @@ const notionInspiredPreset = {
|
|
|
86
89
|
mermaid: true,
|
|
87
90
|
tooltips: true,
|
|
88
91
|
search: false,
|
|
89
|
-
darkMode: true
|
|
92
|
+
darkMode: true,
|
|
93
|
+
phosphorIcons: true,
|
|
94
|
+
phosphorWeight: 'regular',
|
|
95
|
+
phosphorSize: '1.2em'
|
|
90
96
|
},
|
|
91
97
|
|
|
92
98
|
auth: {
|
package/lib/core-builder.js
CHANGED
|
@@ -12,6 +12,7 @@ const {
|
|
|
12
12
|
generateSitemap,
|
|
13
13
|
generateRobotsTxt
|
|
14
14
|
} = require('./seo');
|
|
15
|
+
const { replaceEmojisWithIcons } = require('./emoji-mapper');
|
|
15
16
|
|
|
16
17
|
// Configure marked options
|
|
17
18
|
marked.setOptions({
|
|
@@ -144,7 +145,7 @@ function extractSummary(content, maxLength = 150) {
|
|
|
144
145
|
}
|
|
145
146
|
|
|
146
147
|
// Process markdown content
|
|
147
|
-
function processMarkdownContent(content) {
|
|
148
|
+
function processMarkdownContent(content, config = {}) {
|
|
148
149
|
// Convert mermaid code blocks to mermaid divs with titles
|
|
149
150
|
// Process before markdown parsing to prevent breaking up the content
|
|
150
151
|
const mermaidBlocks = [];
|
|
@@ -186,6 +187,9 @@ function processMarkdownContent(content) {
|
|
|
186
187
|
html = html.replace(`MERMAID_BLOCK_${index}`, block);
|
|
187
188
|
});
|
|
188
189
|
|
|
190
|
+
// Replace emojis with Phosphor icons if enabled
|
|
191
|
+
html = replaceEmojisWithIcons(html, config);
|
|
192
|
+
|
|
189
193
|
return html;
|
|
190
194
|
}
|
|
191
195
|
|
|
@@ -281,6 +285,7 @@ ${seoTags}
|
|
|
281
285
|
|
|
282
286
|
<!-- Icons -->
|
|
283
287
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
288
|
+
${config.features?.phosphorIcons ? `<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/${config.features?.phosphorWeight || 'regular'}/style.css">` : ''}
|
|
284
289
|
|
|
285
290
|
<!-- Mermaid -->
|
|
286
291
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -612,7 +617,7 @@ async function processMarkdownFile(filePath, outputPath, allFiles, config) {
|
|
|
612
617
|
const summary = frontMatter.description || extractSummary(content);
|
|
613
618
|
|
|
614
619
|
// Process content
|
|
615
|
-
const htmlContent = processMarkdownContent(content);
|
|
620
|
+
const htmlContent = processMarkdownContent(content, config);
|
|
616
621
|
|
|
617
622
|
// Build navigation
|
|
618
623
|
const navigation = buildNavigationStructure(allFiles, urlPath);
|