@knowcode/doc-builder 1.4.25 → 1.5.1

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 (26) hide show
  1. package/.claude/settings.local.json +2 -1
  2. package/CHANGELOG.md +52 -0
  3. package/README.md +57 -7
  4. package/assets/404.html +115 -0
  5. package/assets/js/main.js +23 -0
  6. package/cli.js +251 -2
  7. package/doc-builder.config.js +34 -0
  8. package/html/404.html +115 -0
  9. package/html/README.html +71 -5
  10. package/html/claude-workflow-guide.html +71 -5
  11. package/html/documentation-index.html +77 -5
  12. package/html/guides/authentication-guide.html +77 -5
  13. package/html/guides/documentation-standards.html +77 -5
  14. package/html/guides/seo-guide.html +557 -0
  15. package/html/guides/troubleshooting-guide.html +77 -5
  16. package/html/index.html +71 -5
  17. package/html/js/main.js +23 -0
  18. package/html/robots.txt +5 -0
  19. package/html/sitemap.xml +75 -0
  20. package/html/vercel-cli-setup-guide.html +452 -0
  21. package/html/vercel-first-time-setup-guide.html +419 -0
  22. package/lib/config.js +39 -1
  23. package/lib/core-builder.js +110 -5
  24. package/lib/deploy.js +61 -2
  25. package/lib/seo.js +359 -0
  26. package/package.json +1 -1
package/html/guides/troubleshooting-guide.html CHANGED
@@ -3,8 +3,30 @@
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="Documentation site built with @knowcode/doc-builder">
7
- <title>Troubleshooting Guide for @knowcode/doc-builder - Documentation</title>
6
+ <meta name="description" content="Troubleshooting Guide for @knowcode/doc-builder.">
7
+ <title>Troubleshooting Guide for @knowcode/doc-builder - Doc Builder</title>
8
+
9
+ <meta name="author" content="Lindsay Smith">
10
+ <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, issues, check, directory, not, version">
11
+ <meta name="robots" content="index, follow">
12
+ <link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html">
13
+
14
+ <!-- Open Graph / Facebook -->
15
+ <meta property="og:type" content="article">
16
+ <meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html">
17
+ <meta property="og:title" content="Troubleshooting Guide for @knowcode/doc-builder - Doc Builder">
18
+ <meta property="og:description" content="Troubleshooting Guide for @knowcode/doc-builder.">
19
+ <meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
20
+ <meta property="og:site_name" content="Doc Builder">
21
+ <meta property="og:locale" content="en_US">
22
+
23
+ <!-- Twitter Card -->
24
+ <meta name="twitter:card" content="summary_large_image">
25
+ <meta name="twitter:site" content="@planbbackups">
26
+ <meta name="twitter:creator" content="@planbbackups">
27
+ <meta name="twitter:title" content="Troubleshooting Guide for @knowcode/doc-builder - Doc Builder">
28
+ <meta name="twitter:description" content="Troubleshooting Guide for @knowcode/doc-builder.">
29
+ <meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
8
30
 
9
31
  <!-- Fonts -->
10
32
  <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
@@ -20,16 +42,63 @@
20
42
 
21
43
  <!-- Favicon -->
22
44
  <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>">
45
+
46
+ <script type="application/ld+json">
47
+ {
48
+ "@context": "https://schema.org",
49
+ "@type": "TechArticle",
50
+ "headline": "Troubleshooting Guide for @knowcode/doc-builder",
51
+ "description": "Troubleshooting Guide for @knowcode/doc-builder.",
52
+ "author": {
53
+ "@type": "Person",
54
+ "name": "Lindsay Smith"
55
+ },
56
+ "publisher": {
57
+ "@type": "Organization",
58
+ "name": "Knowcode Ltd",
59
+ "url": "https://knowcode.tech"
60
+ },
61
+ "datePublished": "2025-07-21T20:39:06.492Z",
62
+ "dateModified": "2025-07-21T20:39:06.492Z",
63
+ "mainEntityOfPage": {
64
+ "@type": "WebPage",
65
+ "@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
66
+ },
67
+ "breadcrumb": {
68
+ "@type": "BreadcrumbList",
69
+ "itemListElement": [
70
+ {
71
+ "@type": "ListItem",
72
+ "position": 1,
73
+ "name": "Doc Builder",
74
+ "item": "https://doc-builder-delta.vercel.app"
75
+ },
76
+ {
77
+ "@type": "ListItem",
78
+ "position": 2,
79
+ "name": "Guides",
80
+ "item": "https://doc-builder-delta.vercel.app/guides/"
81
+ },
82
+ {
83
+ "@type": "ListItem",
84
+ "position": 3,
85
+ "name": "Troubleshooting Guide",
86
+ "item": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
87
+ }
88
+ ]
89
+ }
90
+ }
91
+ </script>
23
92
  </head>
24
93
  <body>
25
94
  <!-- Header -->
26
95
  <header class="header">
27
96
  <div class="header-content">
28
- <a href="/index.html" class="logo">Documentation</a>
97
+ <a href="/index.html" class="logo">Doc Builder</a>
29
98
 
30
99
  <div class="header-actions">
31
100
  <div class="deployment-info">
32
- <span class="deployment-date" title="Built with doc-builder v1.4.24">Last updated: Jul 21, 2025, 07:50 PM UTC</span>
101
+ <span class="deployment-date" title="Built with doc-builder v1.5.0">Last updated: Jul 21, 2025, 08:39 PM UTC</span>
33
102
  </div>
34
103
 
35
104
 
@@ -80,7 +149,9 @@
80
149
  <div class="nav-content" >
81
150
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
151
  <a href="/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>
83
- <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></div></div>
152
+ <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>
153
+ <a href="/vercel-cli-setup-guide.html" class="nav-item" 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>
154
+ <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>
84
155
  <div class="nav-section" data-level="1">
85
156
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
157
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -88,6 +159,7 @@
88
159
  <div class="nav-content" id="nav-guides-1">
89
160
  <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>
90
161
  <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>
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>
91
163
  <a href="/guides/troubleshooting-guide.html" class="nav-item active" 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>
92
164
  </nav>
93
165
  <div class="resize-handle"></div>
package/html/index.html CHANGED
@@ -3,8 +3,30 @@
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="Documentation site built with @knowcode/doc-builder">
7
- <title>@knowcode/doc-builder - Documentation</title>
6
+ <meta name="description" content="@knowcode/doc-builder.">
7
+ <title>@knowcode/doc-builder - Doc Builder</title>
8
+
9
+ <meta name="author" content="Lindsay Smith">
10
+ <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, knowcode, doc, builder">
11
+ <meta name="robots" content="index, follow">
12
+ <link rel="canonical" href="https://doc-builder-delta.vercel.app/README.html">
13
+
14
+ <!-- Open Graph / Facebook -->
15
+ <meta property="og:type" content="article">
16
+ <meta property="og:url" content="https://doc-builder-delta.vercel.app/README.html">
17
+ <meta property="og:title" content="@knowcode/doc-builder - Doc Builder">
18
+ <meta property="og:description" content="@knowcode/doc-builder.">
19
+ <meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
20
+ <meta property="og:site_name" content="Doc Builder">
21
+ <meta property="og:locale" content="en_US">
22
+
23
+ <!-- Twitter Card -->
24
+ <meta name="twitter:card" content="summary_large_image">
25
+ <meta name="twitter:site" content="@planbbackups">
26
+ <meta name="twitter:creator" content="@planbbackups">
27
+ <meta name="twitter:title" content="@knowcode/doc-builder - Doc Builder">
28
+ <meta name="twitter:description" content="@knowcode/doc-builder.">
29
+ <meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
8
30
 
9
31
  <!-- Fonts -->
10
32
  <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
@@ -20,16 +42,57 @@
20
42
 
21
43
  <!-- Favicon -->
22
44
  <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>">
45
+
46
+ <script type="application/ld+json">
47
+ {
48
+ "@context": "https://schema.org",
49
+ "@type": "TechArticle",
50
+ "headline": "@knowcode/doc-builder",
51
+ "description": "@knowcode/doc-builder.",
52
+ "author": {
53
+ "@type": "Person",
54
+ "name": "Lindsay Smith"
55
+ },
56
+ "publisher": {
57
+ "@type": "Organization",
58
+ "name": "Knowcode Ltd",
59
+ "url": "https://knowcode.tech"
60
+ },
61
+ "datePublished": "2025-07-21T20:39:06.468Z",
62
+ "dateModified": "2025-07-21T20:39:06.468Z",
63
+ "mainEntityOfPage": {
64
+ "@type": "WebPage",
65
+ "@id": "https://doc-builder-delta.vercel.app/README.html"
66
+ },
67
+ "breadcrumb": {
68
+ "@type": "BreadcrumbList",
69
+ "itemListElement": [
70
+ {
71
+ "@type": "ListItem",
72
+ "position": 1,
73
+ "name": "Doc Builder",
74
+ "item": "https://doc-builder-delta.vercel.app"
75
+ },
76
+ {
77
+ "@type": "ListItem",
78
+ "position": 2,
79
+ "name": "README",
80
+ "item": "https://doc-builder-delta.vercel.app/README.html"
81
+ }
82
+ ]
83
+ }
84
+ }
85
+ </script>
23
86
  </head>
24
87
  <body>
25
88
  <!-- Header -->
26
89
  <header class="header">
27
90
  <div class="header-content">
28
- <a href="/index.html" class="logo">Documentation</a>
91
+ <a href="/index.html" class="logo">Doc Builder</a>
29
92
 
30
93
  <div class="header-actions">
31
94
  <div class="deployment-info">
32
- <span class="deployment-date" title="Built with doc-builder v1.4.24">Last updated: Jul 21, 2025, 07:50 PM UTC</span>
95
+ <span class="deployment-date" title="Built with doc-builder v1.5.0">Last updated: Jul 21, 2025, 08:39 PM UTC</span>
33
96
  </div>
34
97
 
35
98
 
@@ -80,7 +143,9 @@
80
143
  <div class="nav-content" >
81
144
  <a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
145
  <a href="/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>
83
- <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></div></div>
146
+ <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>
147
+ <a href="/vercel-cli-setup-guide.html" class="nav-item" 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>
148
+ <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>
84
149
  <div class="nav-section" data-level="1">
85
150
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
151
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -88,6 +153,7 @@
88
153
  <div class="nav-content" id="nav-guides-1">
89
154
  <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>
90
155
  <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>
156
+ <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>
91
157
  <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>
92
158
  </nav>
93
159
  <div class="resize-handle"></div>
package/html/js/main.js CHANGED
@@ -1318,8 +1318,31 @@ function initTooltips() {
1318
1318
  });
1319
1319
  }
1320
1320
 
1321
+ // Handle .md link redirects
1322
+ function initMarkdownLinkRedirects() {
1323
+ // Check if current URL ends with .md and redirect
1324
+ if (window.location.pathname.endsWith('.md')) {
1325
+ const htmlPath = window.location.pathname.replace(/\.md$/, '.html');
1326
+ console.log(`Redirecting from .md to .html: ${htmlPath}`);
1327
+ window.location.replace(htmlPath);
1328
+ return; // Stop execution as we're redirecting
1329
+ }
1330
+
1331
+ // Intercept clicks on .md links
1332
+ document.addEventListener('click', function(e) {
1333
+ const link = e.target.closest('a');
1334
+ if (link && link.href && link.href.endsWith('.md')) {
1335
+ e.preventDefault();
1336
+ const htmlUrl = link.href.replace(/\.md$/, '.html');
1337
+ console.log(`Converting .md link to .html: ${htmlUrl}`);
1338
+ window.location.href = htmlUrl;
1339
+ }
1340
+ });
1341
+ }
1342
+
1321
1343
  // Initialize on DOM Load
1322
1344
  document.addEventListener('DOMContentLoaded', () => {
1345
+ initMarkdownLinkRedirects();
1323
1346
  highlightNavigation();
1324
1347
  generateTableOfContents();
1325
1348
  initSidebarResize();
package/html/robots.txt ADDED
@@ -0,0 +1,5 @@
1
+ User-agent: *
2
+ Allow: /
3
+
4
+ # Sitemap location
5
+ Sitemap: https://doc-builder-delta.vercel.app/sitemap.xml
package/html/sitemap.xml ADDED
@@ -0,0 +1,75 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
3
+ <url>
4
+ <loc>https://doc-builder-delta.vercel.app/404.html</loc>
5
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
6
+ <changefreq>monthly</changefreq>
7
+ <priority>0.6</priority>
8
+ </url>
9
+ <url>
10
+ <loc>https://doc-builder-delta.vercel.app/README.html</loc>
11
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
12
+ <changefreq>monthly</changefreq>
13
+ <priority>0.6</priority>
14
+ </url>
15
+ <url>
16
+ <loc>https://doc-builder-delta.vercel.app/claude-workflow-guide.html</loc>
17
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
18
+ <changefreq>monthly</changefreq>
19
+ <priority>0.8</priority>
20
+ </url>
21
+ <url>
22
+ <loc>https://doc-builder-delta.vercel.app/documentation-index.html</loc>
23
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
24
+ <changefreq>monthly</changefreq>
25
+ <priority>0.6</priority>
26
+ </url>
27
+ <url>
28
+ <loc>https://doc-builder-delta.vercel.app/guides/authentication-guide.html</loc>
29
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
30
+ <changefreq>monthly</changefreq>
31
+ <priority>0.8</priority>
32
+ </url>
33
+ <url>
34
+ <loc>https://doc-builder-delta.vercel.app/guides/document-standards.html</loc>
35
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
36
+ <changefreq>monthly</changefreq>
37
+ <priority>0.8</priority>
38
+ </url>
39
+ <url>
40
+ <loc>https://doc-builder-delta.vercel.app/guides/documentation-standards.html</loc>
41
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
42
+ <changefreq>monthly</changefreq>
43
+ <priority>0.8</priority>
44
+ </url>
45
+ <url>
46
+ <loc>https://doc-builder-delta.vercel.app/guides/seo-guide.html</loc>
47
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
48
+ <changefreq>monthly</changefreq>
49
+ <priority>0.8</priority>
50
+ </url>
51
+ <url>
52
+ <loc>https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html</loc>
53
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
54
+ <changefreq>monthly</changefreq>
55
+ <priority>0.8</priority>
56
+ </url>
57
+ <url>
58
+ <loc>https://doc-builder-delta.vercel.app/index.html</loc>
59
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
60
+ <changefreq>weekly</changefreq>
61
+ <priority>1.0</priority>
62
+ </url>
63
+ <url>
64
+ <loc>https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html</loc>
65
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
66
+ <changefreq>monthly</changefreq>
67
+ <priority>0.8</priority>
68
+ </url>
69
+ <url>
70
+ <loc>https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html</loc>
71
+ <lastmod>2025-07-21T20:39:06.503Z</lastmod>
72
+ <changefreq>monthly</changefreq>
73
+ <priority>0.8</priority>
74
+ </url>
75
+ </urlset>