@knowcode/doc-builder 1.5.15 ā 1.5.17
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/.claude/settings.local.json +2 -1
- package/CHANGELOG.md +28 -0
- package/README.md +103 -35
- package/assets/css/notion-style.css +2 -0
- package/assets/js/main.js +0 -18
- package/cli.js +22 -22
- package/html/README.html +209 -95
- package/html/css/notion-style.css +21 -13
- package/html/documentation-index.html +5 -4
- package/html/guides/authentication-guide.html +10 -10
- package/html/guides/claude-workflow-guide.html +5 -10
- package/html/guides/documentation-standards.html +5 -5
- package/html/guides/google-site-verification-guide.html +5 -4
- package/html/guides/phosphor-icons-guide.html +5 -4
- package/html/guides/seo-guide.html +9 -8
- package/html/guides/seo-optimization-guide.html +5 -4
- package/html/guides/troubleshooting-guide.html +15 -15
- package/html/guides/windows-setup-guide.html +667 -0
- package/html/index.html +209 -95
- package/html/js/main.js +0 -18
- package/html/sitemap.xml +22 -16
- package/html/vercel-cli-setup-guide.html +7 -6
- package/html/vercel-first-time-setup-guide.html +7 -6
- package/lib/core-builder.js +5 -6
- package/lib/deploy.js +6 -6
- package/package.json +1 -1
- package/recordings/mh-ls-22jul.txt +2305 -0
- package/scripts/setup.js +3 -3
- package/Screenshot 2025-07-21 at 11.52.33.png +0 -0
- package/Screenshot 2025-07-21 at 12.14.39.png +0 -0
- package/Screenshot 2025-07-21 at 17.13.17.png +0 -0
- package/Screenshot 2025-07-21 at 17.16.15.png +0 -0
- package/Screenshot 2025-07-22 at 12.14.13.png +0 -0
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T15:31:48.183Z",
|
|
66
|
+
"dateModified": "2025-07-22T15:31:48.183Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html"
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
|
|
97
97
|
<div class="header-actions">
|
|
98
98
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.16">Last updated: Jul 22, 2025, 03:31 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -161,7 +161,8 @@
|
|
|
161
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>
|
|
162
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>
|
|
163
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>
|
|
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
|
|
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>
|
|
165
|
+
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
165
166
|
</nav>
|
|
166
167
|
<div class="resize-handle"></div>
|
|
167
168
|
</aside>
|
|
@@ -175,7 +176,7 @@
|
|
|
175
176
|
<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>
|
|
176
177
|
<h2>The Simplified Process</h2>
|
|
177
178
|
<h3>Step 1: Run the Deploy Command</h3>
|
|
178
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder deploy
|
|
179
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
179
180
|
</code></pre>
|
|
180
181
|
<h3>Step 2: doc-builder Configuration</h3>
|
|
181
182
|
<p>The tool will ask a few simple questions:</p>
|
|
@@ -299,7 +300,7 @@
|
|
|
299
300
|
<li>You have internet connection</li>
|
|
300
301
|
</ol>
|
|
301
302
|
<h2>Quick Checklist</h2>
|
|
302
|
-
<pre><code><i class="ph ph-check-circle" aria-label="checked"></i> 1. Run: npx @knowcode/doc-builder deploy
|
|
303
|
+
<pre><code><i class="ph ph-check-circle" aria-label="checked"></i> 1. Run: npx @knowcode/doc-builder@latest deploy
|
|
303
304
|
<i class="ph ph-check-circle" aria-label="checked"></i> 2. Enter project name (e.g., my-docs)
|
|
304
305
|
<i class="ph ph-check-circle" aria-label="checked"></i> 3. Skip custom URL (press Enter)
|
|
305
306
|
<i class="ph ph-check-circle" aria-label="checked"></i> 4. Confirm deployment when Vercel asks
|
package/lib/core-builder.js
CHANGED
|
@@ -172,7 +172,6 @@ function processMarkdownContent(content, config = {}) {
|
|
|
172
172
|
// Store the mermaid block and return a placeholder
|
|
173
173
|
const placeholder = `MERMAID_BLOCK_${mermaidBlocks.length}`;
|
|
174
174
|
mermaidBlocks.push(`<div class="mermaid-wrapper">
|
|
175
|
-
<div class="mermaid-title">${escapeHtml(title)}</div>
|
|
176
175
|
<div class="mermaid">${mermaidContent.trim()}</div>
|
|
177
176
|
</div>`);
|
|
178
177
|
return placeholder;
|
|
@@ -918,7 +917,7 @@ This documentation site was built with @knowcode/doc-builder. This is an auto-ge
|
|
|
918
917
|
1. **Replace this file**: Edit \`docs/README.md\` with your project's actual documentation
|
|
919
918
|
2. **Add content**: Create additional markdown files in the \`docs/\` directory
|
|
920
919
|
3. **Organize with folders**: Use subfolders to structure your documentation
|
|
921
|
-
4. **Rebuild**: Run \`npx @knowcode/doc-builder build\` to regenerate the site
|
|
920
|
+
4. **Rebuild**: Run \`npx @knowcode/doc-builder@latest build\` to regenerate the site
|
|
922
921
|
|
|
923
922
|
## Documentation Structure
|
|
924
923
|
|
|
@@ -936,7 +935,7 @@ Your documentation can include:
|
|
|
936
935
|
2. Create additional markdown files for your content
|
|
937
936
|
3. Organize files into logical folders
|
|
938
937
|
4. Use Mermaid diagrams for visual explanations
|
|
939
|
-
5. Deploy with \`npx @knowcode/doc-builder deploy\`
|
|
938
|
+
5. Deploy with \`npx @knowcode/doc-builder@latest deploy\`
|
|
940
939
|
|
|
941
940
|
## Documentation Standards
|
|
942
941
|
|
|
@@ -970,7 +969,7 @@ graph TD
|
|
|
970
969
|
|
|
971
970
|
For help with @knowcode/doc-builder:
|
|
972
971
|
- Check the documentation at your package source
|
|
973
|
-
- Use \`npx @knowcode/doc-builder --help\` for CLI options
|
|
972
|
+
- Use \`npx @knowcode/doc-builder@latest --help\` for CLI options
|
|
974
973
|
- Review the generated configuration guide if available
|
|
975
974
|
`;
|
|
976
975
|
|
|
@@ -1208,8 +1207,8 @@ This is the homepage for my documentation.
|
|
|
1208
1207
|
<ol>
|
|
1209
1208
|
<li>Create <code>docs/index.md</code> or <code>docs/README.md</code></li>
|
|
1210
1209
|
<li>Add more markdown files for additional pages</li>
|
|
1211
|
-
<li>Rebuild: <code>npx @knowcode/doc-builder build</code></li>
|
|
1212
|
-
<li>Deploy: <code>npx @knowcode/doc-builder deploy</code></li>
|
|
1210
|
+
<li>Rebuild: <code>npx @knowcode/doc-builder@latest build</code></li>
|
|
1211
|
+
<li>Deploy: <code>npx @knowcode/doc-builder@latest deploy</code></li>
|
|
1213
1212
|
</ol>
|
|
1214
1213
|
|
|
1215
1214
|
${fileListHtml}
|
package/lib/deploy.js
CHANGED
|
@@ -26,7 +26,7 @@ async function setupVercelProject(config) {
|
|
|
26
26
|
name: 'projectName',
|
|
27
27
|
message: 'What is your project name?',
|
|
28
28
|
initial: config.siteName.toLowerCase().replace(/[^a-z0-9-]/g, '-') || 'my-docs',
|
|
29
|
-
hint: '
|
|
29
|
+
hint: 'Lowercase only, letters/numbers/hyphens. This becomes: project-name.vercel.app'
|
|
30
30
|
},
|
|
31
31
|
{
|
|
32
32
|
type: 'text',
|
|
@@ -190,8 +190,8 @@ async function deployToVercel(config, isProd = false) {
|
|
|
190
190
|
console.log(chalk.yellow(' Your documentation may appear without styling.'));
|
|
191
191
|
console.log(chalk.cyan('\nš” To fix this:'));
|
|
192
192
|
console.log(chalk.white(' 1. Update to latest version: ') + chalk.gray('npm update @knowcode/doc-builder'));
|
|
193
|
-
console.log(chalk.white(' 2. Rebuild your docs: ') + chalk.gray('npx @knowcode/doc-builder build'));
|
|
194
|
-
console.log(chalk.white(' 3. Then deploy again: ') + chalk.gray('npx @knowcode/doc-builder deploy\n'));
|
|
193
|
+
console.log(chalk.white(' 2. Rebuild your docs: ') + chalk.gray('npx @knowcode/doc-builder@latest build'));
|
|
194
|
+
console.log(chalk.white(' 3. Then deploy again: ') + chalk.gray('npx @knowcode/doc-builder@latest deploy\n'));
|
|
195
195
|
}
|
|
196
196
|
|
|
197
197
|
// Simple deployment message
|
|
@@ -399,8 +399,8 @@ async function deployToVercel(config, isProd = false) {
|
|
|
399
399
|
console.log(chalk.cyan('4. Save and try again\n'));
|
|
400
400
|
|
|
401
401
|
console.log(chalk.white('Option 2 - Reset and start fresh:'));
|
|
402
|
-
console.log(chalk.cyan('1. Run: npx @knowcode/doc-builder reset-vercel'));
|
|
403
|
-
console.log(chalk.cyan('2. Run: npx @knowcode/doc-builder deploy'));
|
|
402
|
+
console.log(chalk.cyan('1. Run: npx @knowcode/doc-builder@latest reset-vercel'));
|
|
403
|
+
console.log(chalk.cyan('2. Run: npx @knowcode/doc-builder@latest deploy'));
|
|
404
404
|
console.log(chalk.cyan('3. Create a NEW project (don\'t link to existing)\n'));
|
|
405
405
|
|
|
406
406
|
throw new Error('Build settings conflict - see instructions above');
|
|
@@ -481,7 +481,7 @@ async function prepareDeployment(config) {
|
|
|
481
481
|
// Created redirect
|
|
482
482
|
} else {
|
|
483
483
|
// No HTML files at all - this should never happen after build
|
|
484
|
-
console.error(chalk.red('No HTML files found. Run: npx @knowcode/doc-builder build'));
|
|
484
|
+
console.error(chalk.red('No HTML files found. Run: npx @knowcode/doc-builder@latest build'));
|
|
485
485
|
|
|
486
486
|
// Create emergency fallback page
|
|
487
487
|
const { createDefaultIndexPage } = require('./core-builder');
|