@knowcode/doc-builder 1.5.8 → 1.5.10

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.
@@ -25,7 +25,8 @@
25
25
  "Bash(vercel alias:*)",
26
26
  "Bash(find:*)",
27
27
  "Bash(diff:*)",
28
- "Bash(git log:*)"
28
+ "Bash(git log:*)",
29
+ "Bash(mkdir:*)"
29
30
  ],
30
31
  "deny": []
31
32
  }
package/CHANGELOG.md CHANGED
@@ -5,6 +5,36 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [1.5.10] - 2025-07-22
9
+
10
+ ### Fixed
11
+ - Automatically create missing docs directory when running build, dev, or deploy commands
12
+ - No longer fails with "ENOENT: no such file or directory" when docs folder is missing
13
+ - Creates placeholder README.md in newly created docs directory
14
+ - Removed duplicate warning messages about missing docs directory
15
+
16
+ ### Improved
17
+ - Better handling of empty projects - just run `doc-builder build` and it creates everything needed
18
+ - Cleaner console output without redundant warnings
19
+ - Ensures output directory exists before building
20
+
21
+ ## [1.5.9] - 2025-07-22
22
+
23
+ ### Added
24
+ - Comprehensive SEO Optimization Guide with extensive external resources
25
+ - Detailed explanations of all SEO features and how they work
26
+ - References to 20+ external SEO tools and learning resources
27
+ - Keyword research tools and performance testing recommendations
28
+ - SEO monitoring strategies and success metrics
29
+ - Actionable SEO checklist for documentation projects
30
+
31
+ ### Documentation
32
+ - Created detailed guide explaining automatic meta tag generation
33
+ - Added sections on Open Graph Protocol and Twitter Cards
34
+ - Included structured data (JSON-LD) explanations
35
+ - Referenced Google's official SEO guidelines and best practices
36
+ - Added links to free SEO tools and validators
37
+
8
38
  ## [1.5.8] - 2025-07-22
9
39
 
10
40
  ### Changed
package/cli.js CHANGED
@@ -83,7 +83,7 @@ ${chalk.yellow('Examples:')}
83
83
  const spinner = ora('Building documentation...').start();
84
84
 
85
85
  try {
86
- const config = await loadConfig(options.config || 'doc-builder.config.js', options);
86
+ const config = await loadConfig(options.config || 'doc-builder.config.js', { ...options, command: 'build' });
87
87
  await build(config);
88
88
  spinner.succeed('Documentation built successfully!');
89
89
  } catch (error) {
@@ -112,7 +112,7 @@ ${chalk.yellow('Examples:')}
112
112
  `)
113
113
  .action(async (options) => {
114
114
  try {
115
- const config = await loadConfig(options.config, options);
115
+ const config = await loadConfig(options.config, { ...options, command: 'dev' });
116
116
  await startDevServer(config, options.port);
117
117
  } catch (error) {
118
118
  console.error(chalk.red(error.message));
@@ -645,7 +645,7 @@ ${chalk.yellow('Troubleshooting:')}
645
645
  const spinner = ora('Deploying to Vercel...').start();
646
646
 
647
647
  try {
648
- const config = await loadConfig(options.config || 'doc-builder.config.js', options);
648
+ const config = await loadConfig(options.config || 'doc-builder.config.js', { ...options, command: 'deploy' });
649
649
 
650
650
  // First check if Vercel CLI is installed
651
651
  try {
package/html/README.html CHANGED
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.857Z",
65
- "dateModified": "2025-07-22T08:09:57.857Z",
64
+ "datePublished": "2025-07-22T08:32:13.098Z",
65
+ "dateModified": "2025-07-22T08:32:13.098Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/README.html"
@@ -95,7 +95,7 @@
95
95
 
96
96
  <div class="header-actions">
97
97
  <div class="deployment-info">
98
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
98
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
99
  </div>
100
100
 
101
101
 
@@ -158,7 +158,7 @@
158
158
  <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
159
  <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>
160
160
  <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
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
161
+ <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
162
  <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>
163
163
  </nav>
164
164
  <div class="resize-handle"></div>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.871Z",
65
- "dateModified": "2025-07-22T08:09:57.871Z",
64
+ "datePublished": "2025-07-22T08:32:13.109Z",
65
+ "dateModified": "2025-07-22T08:32:13.109Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
@@ -95,7 +95,7 @@
95
95
 
96
96
  <div class="header-actions">
97
97
  <div class="deployment-info">
98
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
98
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
99
  </div>
100
100
 
101
101
 
@@ -158,7 +158,7 @@
158
158
  <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
159
  <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>
160
160
  <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
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
161
+ <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
162
  <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>
163
163
  </nav>
164
164
  <div class="resize-handle"></div>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.875Z",
65
- "dateModified": "2025-07-22T08:09:57.875Z",
64
+ "datePublished": "2025-07-22T08:32:13.111Z",
65
+ "dateModified": "2025-07-22T08:32:13.111Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
@@ -101,7 +101,7 @@
101
101
 
102
102
  <div class="header-actions">
103
103
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
104
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
105
  </div>
106
106
 
107
107
 
@@ -164,7 +164,7 @@
164
164
  <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>
165
165
  <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>
166
166
  <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>
167
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
167
+ <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>
168
168
  <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>
169
169
  </nav>
170
170
  <div class="resize-handle"></div>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.879Z",
65
- "dateModified": "2025-07-22T08:09:57.879Z",
64
+ "datePublished": "2025-07-22T08:32:13.114Z",
65
+ "dateModified": "2025-07-22T08:32:13.114Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html"
@@ -101,7 +101,7 @@
101
101
 
102
102
  <div class="header-actions">
103
103
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
104
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
105
  </div>
106
106
 
107
107
 
@@ -164,7 +164,7 @@
164
164
  <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>
165
165
  <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>
166
166
  <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>
167
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
167
+ <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>
168
168
  <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>
169
169
  </nav>
170
170
  <div class="resize-handle"></div>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.884Z",
65
- "dateModified": "2025-07-22T08:09:57.884Z",
64
+ "datePublished": "2025-07-22T08:32:13.118Z",
65
+ "dateModified": "2025-07-22T08:32:13.118Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/guides/documentation-standards.html"
@@ -101,7 +101,7 @@
101
101
 
102
102
  <div class="header-actions">
103
103
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
104
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
105
  </div>
106
106
 
107
107
 
@@ -164,7 +164,7 @@
164
164
  <a href="/guides/documentation-standards.html" class="nav-item active" 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>
165
165
  <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>
166
166
  <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>
167
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
167
+ <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>
168
168
  <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>
169
169
  </nav>
170
170
  <div class="resize-handle"></div>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.893Z",
65
- "dateModified": "2025-07-22T08:09:57.893Z",
64
+ "datePublished": "2025-07-22T08:32:13.126Z",
65
+ "dateModified": "2025-07-22T08:32:13.126Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/guides/google-site-verification-guide.html"
@@ -101,7 +101,7 @@
101
101
 
102
102
  <div class="header-actions">
103
103
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
104
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
105
  </div>
106
106
 
107
107
 
@@ -164,7 +164,7 @@
164
164
  <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>
165
165
  <a href="/guides/google-site-verification-guide.html" class="nav-item active" 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>
166
166
  <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>
167
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
167
+ <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>
168
168
  <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>
169
169
  </nav>
170
170
  <div class="resize-handle"></div>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.898Z",
65
- "dateModified": "2025-07-22T08:09:57.898Z",
64
+ "datePublished": "2025-07-22T08:32:13.130Z",
65
+ "dateModified": "2025-07-22T08:32:13.130Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/guides/seo-guide.html"
@@ -101,7 +101,7 @@
101
101
 
102
102
  <div class="header-actions">
103
103
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
104
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
105
  </div>
106
106
 
107
107
 
@@ -164,7 +164,7 @@
164
164
  <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>
165
165
  <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>
166
166
  <a href="/guides/seo-guide.html" class="nav-item active" 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>
167
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
167
+ <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>
168
168
  <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>
169
169
  </nav>
170
170
  <div class="resize-handle"></div>
@@ -3,7 +3,7 @@
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="Learn how to optimize your documentation for search engines with front matter, smart titles, and keyword strategies for better rankings.">
6
+ <meta name="description" content="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings.">
7
7
  <title>SEO Optimization Guide for @knowcode/doc-builder</title>
8
8
 
9
9
  <meta name="author" content="Lindsay Smith">
@@ -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/guides/seo-optimization-guide.html">
17
17
  <meta property="og:title" content="SEO Optimization Guide for @knowcode/doc-builder">
18
- <meta property="og:description" content="Learn how to optimize your documentation for search engines with front matter, smart titles, and keyword strategies for better rankings.">
18
+ <meta property="og:description" content="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings.">
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="SEO Optimization Guide for @knowcode/doc-builder">
28
- <meta name="twitter:description" content="Learn how to optimize your documentation for search engines with front matter, smart titles, and keyword strategies for better rankings.">
28
+ <meta name="twitter:description" content="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings.">
29
29
  <meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
30
30
 
31
31
  <!-- Custom Meta Tags -->
@@ -51,7 +51,7 @@
51
51
  "@context": "https://schema.org",
52
52
  "@type": "TechArticle",
53
53
  "headline": "SEO Optimization Guide for @knowcode/doc-builder",
54
- "description": "Learn how to optimize your documentation for search engines with front matter, smart titles, and keyword strategies for better rankings.",
54
+ "description": "Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings.",
55
55
  "author": {
56
56
  "@type": "Person",
57
57
  "name": "Lindsay Smith"
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.904Z",
65
- "dateModified": "2025-07-22T08:09:57.904Z",
64
+ "datePublished": "2025-07-22T08:32:13.137Z",
65
+ "dateModified": "2025-07-22T08:32:13.137Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
@@ -101,7 +101,7 @@
101
101
 
102
102
  <div class="header-actions">
103
103
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
104
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
105
  </div>
106
106
 
107
107
 
@@ -164,7 +164,7 @@
164
164
  <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>
165
165
  <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>
166
166
  <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>
167
- <a href="/guides/seo-optimization-guide.html" class="nav-item active" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
167
+ <a href="/guides/seo-optimization-guide.html" class="nav-item active" 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>
168
168
  <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>
169
169
  </nav>
170
170
  <div class="resize-handle"></div>
@@ -174,16 +174,104 @@
174
174
  <main class="content">
175
175
  <div class="content-inner">
176
176
  <h1>SEO Optimization Guide</h1>
177
- <p>This guide explains how to optimize your documentation for search engines using @knowcode/doc-builder&#39;s advanced SEO features.</p>
177
+ <p><strong>Generated</strong>: 2025-07-22 09:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
178
178
  <h2>Overview</h2>
179
+ <p>@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search engines. This guide explains what these features do, how to use them effectively, and provides references to authoritative SEO resources.</p>
180
+ <h2>Why SEO Matters for Documentation</h2>
179
181
  <p>Good SEO helps your documentation:</p>
180
182
  <ul>
181
- <li>Rank higher in search results</li>
182
- <li>Get more organic traffic</li>
183
- <li>Improve click-through rates</li>
184
- <li>Reach the right audience</li>
185
- <li>Build domain authority</li>
183
+ <li><strong>Rank higher</strong> in search results (Google, Bing, DuckDuckGo)</li>
184
+ <li><strong>Get more organic traffic</strong> from developers searching for solutions</li>
185
+ <li><strong>Improve click-through rates</strong> with compelling titles and descriptions</li>
186
+ <li><strong>Reach the right audience</strong> with targeted keywords</li>
187
+ <li><strong>Build domain authority</strong> and credibility</li>
186
188
  </ul>
189
+ <p>According to <a href="https://developers.google.com/search/docs/fundamentals/creating-helpful-content">Google&#39;s Search Quality Guidelines</a>, high-quality technical documentation that helps users is prioritized in search results.</p>
190
+ <h2>What Our SEO Features Do</h2>
191
+ <h3>1. Automatic Meta Tag Generation</h3>
192
+ <p>Doc-builder automatically generates essential HTML meta tags for every page:</p>
193
+ <pre><code class="language-html">&lt;!-- Page Title - Shows in browser tabs and search results --&gt;
194
+ &lt;title&gt;Your Page Title | Site Name&lt;/title&gt;
195
+
196
+ &lt;!-- Meta Description - The snippet shown in search results --&gt;
197
+ &lt;meta name=&quot;description&quot; content=&quot;Your page description here&quot;&gt;
198
+
199
+ &lt;!-- Keywords - Helps search engines understand topic relevance --&gt;
200
+ &lt;meta name=&quot;keywords&quot; content=&quot;keyword1, keyword2, keyword3&quot;&gt;
201
+
202
+ &lt;!-- Author Information --&gt;
203
+ &lt;meta name=&quot;author&quot; content=&quot;Your Name&quot;&gt;
204
+
205
+ &lt;!-- Canonical URL - Prevents duplicate content issues --&gt;
206
+ &lt;link rel=&quot;canonical&quot; href=&quot;https://yoursite.com/page.html&quot;&gt;
207
+
208
+ &lt;!-- Language and Region --&gt;
209
+ &lt;meta property=&quot;og:locale&quot; content=&quot;en_US&quot;&gt;
210
+ </code></pre>
211
+ <h3>2. Open Graph Protocol (Facebook, LinkedIn, Slack)</h3>
212
+ <p>Ensures your documentation looks professional when shared on social media:</p>
213
+ <pre><code class="language-html">&lt;meta property=&quot;og:type&quot; content=&quot;article&quot;&gt;
214
+ &lt;meta property=&quot;og:title&quot; content=&quot;Page Title&quot;&gt;
215
+ &lt;meta property=&quot;og:description&quot; content=&quot;Page description&quot;&gt;
216
+ &lt;meta property=&quot;og:url&quot; content=&quot;https://yoursite.com/page.html&quot;&gt;
217
+ &lt;meta property=&quot;og:image&quot; content=&quot;https://yoursite.com/og-image.png&quot;&gt;
218
+ &lt;meta property=&quot;og:site_name&quot; content=&quot;Your Site Name&quot;&gt;
219
+ </code></pre>
220
+ <p>Learn more: <a href="https://ogp.me/">Open Graph Protocol Official Documentation</a></p>
221
+ <h3>3. Twitter Card Tags</h3>
222
+ <p>Optimizes how your documentation appears on Twitter/X:</p>
223
+ <pre><code class="language-html">&lt;meta name=&quot;twitter:card&quot; content=&quot;summary_large_image&quot;&gt;
224
+ &lt;meta name=&quot;twitter:site&quot; content=&quot;@yourhandle&quot;&gt;
225
+ &lt;meta name=&quot;twitter:title&quot; content=&quot;Page Title&quot;&gt;
226
+ &lt;meta name=&quot;twitter:description&quot; content=&quot;Page description&quot;&gt;
227
+ &lt;meta name=&quot;twitter:image&quot; content=&quot;https://yoursite.com/twitter-image.png&quot;&gt;
228
+ </code></pre>
229
+ <p>Test your cards: <a href="https://cards-dev.twitter.com/validator">Twitter Card Validator</a></p>
230
+ <h3>4. Structured Data (JSON-LD)</h3>
231
+ <p>Helps search engines understand your content structure and display rich snippets:</p>
232
+ <pre><code class="language-json">{
233
+ &quot;@context&quot;: &quot;https://schema.org&quot;,
234
+ &quot;@type&quot;: &quot;TechArticle&quot;,
235
+ &quot;headline&quot;: &quot;Your Page Title&quot;,
236
+ &quot;description&quot;: &quot;Your page description&quot;,
237
+ &quot;author&quot;: {
238
+ &quot;@type&quot;: &quot;Person&quot;,
239
+ &quot;name&quot;: &quot;Author Name&quot;
240
+ },
241
+ &quot;publisher&quot;: {
242
+ &quot;@type&quot;: &quot;Organization&quot;,
243
+ &quot;name&quot;: &quot;Your Organization&quot;,
244
+ &quot;url&quot;: &quot;https://yoursite.com&quot;
245
+ },
246
+ &quot;datePublished&quot;: &quot;2025-01-22&quot;,
247
+ &quot;dateModified&quot;: &quot;2025-01-22&quot;,
248
+ &quot;breadcrumb&quot;: {
249
+ &quot;@type&quot;: &quot;BreadcrumbList&quot;,
250
+ &quot;itemListElement&quot;: [...]
251
+ }
252
+ }
253
+ </code></pre>
254
+ <p>Validate your structured data: <a href="https://search.google.com/test/rich-results">Google&#39;s Rich Results Test</a></p>
255
+ <h3>5. Automatic Sitemap Generation</h3>
256
+ <p>Creates a <code>sitemap.xml</code> file that helps search engines discover all your pages:</p>
257
+ <pre><code class="language-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
258
+ &lt;urlset xmlns=&quot;http://www.sitemaps.org/schemas/sitemap/0.9&quot;&gt;
259
+ &lt;url&gt;
260
+ &lt;loc&gt;https://yoursite.com/index.html&lt;/loc&gt;
261
+ &lt;lastmod&gt;2025-01-22&lt;/lastmod&gt;
262
+ &lt;changefreq&gt;weekly&lt;/changefreq&gt;
263
+ &lt;priority&gt;1.0&lt;/priority&gt;
264
+ &lt;/url&gt;
265
+ &lt;!-- More URLs --&gt;
266
+ &lt;/urlset&gt;
267
+ </code></pre>
268
+ <p>Submit your sitemap: <a href="https://search.google.com/search-console">Google Search Console</a></p>
269
+ <h3>6. Robots.txt Generation</h3>
270
+ <p>Controls how search engines crawl your site:</p>
271
+ <pre><code>User-agent: *
272
+ Allow: /
273
+ Sitemap: https://yoursite.com/sitemap.xml
274
+ </code></pre>
187
275
  <h2>Front Matter Support (v1.5.5+)</h2>
188
276
  <p>@knowcode/doc-builder now supports YAML front matter for page-specific SEO customization:</p>
189
277
  <pre><code class="language-yaml">---
@@ -286,43 +374,52 @@ keywords:
286
374
  - &quot;doc-builder security&quot;
287
375
  ---
288
376
  </code></pre>
289
- <h2>Using the SEO Check Command</h2>
290
- <p>Analyze your documentation&#39;s SEO:</p>
291
- <pre><code class="language-bash"># Check all pages
292
- doc-builder seo-check
377
+ <h2>Using the SEO Check Command (v1.5.8+)</h2>
378
+ <p>The <code>seo-check</code> command analyzes your <strong>generated HTML files</strong> to ensure they&#39;re properly optimized:</p>
379
+ <pre><code class="language-bash"># First, build your documentation
380
+ doc-builder build
293
381
 
294
- # Check specific page
295
- doc-builder seo-check docs/guide.md
382
+ # Then analyze the generated HTML
383
+ doc-builder seo-check
296
384
 
297
- # Auto-fix issues (coming soon)
298
- doc-builder seo-check --fix
385
+ # Check specific HTML file
386
+ doc-builder seo-check html/guide.html
299
387
  </code></pre>
300
- <h3>What It Checks</h3>
388
+ <h3>What It Analyzes in HTML</h3>
389
+ <p>The command inspects the actual HTML output that search engines see:</p>
301
390
  <ul>
302
- <li>✓ Title length and optimization</li>
303
- <li>✓ Description length and quality</li>
304
- <li>✓ Keywords presence</li>
305
- <li>✓ Front matter usage</li>
306
- <li>✓ Duplicate content</li>
391
+ <li>✅ <strong>Title tags</strong> - Presence and optimal length (50-60 chars)</li>
392
+ <li>✅ <strong>Meta descriptions</strong> - Quality and character count (140-160)</li>
393
+ <li>✅ <strong>Keywords meta tag</strong> - Presence of relevant keywords</li>
394
+ <li>✅ <strong>Canonical URLs</strong> - Prevents duplicate content penalties</li>
395
+ <li>✅ <strong>H1 tags</strong> - Ensures proper heading structure</li>
396
+ <li>✅ <strong>Open Graph tags</strong> - Social media optimization</li>
397
+ <li>✅ <strong>Twitter Card tags</strong> - Twitter/X optimization</li>
398
+ <li>✅ <strong>Structured data</strong> - JSON-LD implementation</li>
307
399
  </ul>
308
400
  <h3>Example Output</h3>
309
- <pre><code>🔍 Analyzing SEO...
401
+ <pre><code>🔍 Analyzing SEO in generated HTML files...
310
402
 
311
403
  📊 SEO Analysis Complete
312
404
 
313
- Analyzed 10 files
405
+ Analyzed 14 files
314
406
 
315
407
  ❌ Found 2 issues:
316
408
 
317
- guides/api.md:
409
+ guides/api.html:
318
410
  Title too long (75 chars, max 60)
319
411
  Suggestion: API Reference Documentation for Doc Build...
320
412
 
321
- 💡 5 suggestions:
413
+ setup.html:
414
+ Missing meta description
415
+
416
+ 💡 8 suggestions:
322
417
 
323
- README.md: No keywords defined in front matter
324
- guides/setup.md: Description might be too short (95 chars, ideal 140-160)
325
- guides/deploy.md: No SEO front matter found
418
+ index.html: Description too short (95 chars, ideal 140-160)
419
+ guides/auth.html: No keywords meta tag found
420
+ api/endpoints.html: Missing canonical URL
421
+ tutorials/intro.html: H1 differs from page title
422
+ guides/deploy.html: Missing Open Graph tags
326
423
  </code></pre>
327
424
  <h2>Advanced Configuration</h2>
328
425
  <h3>Per-Page Customization</h3>
@@ -453,34 +550,232 @@ Your content here...
453
550
  <li>Expand content for high-value pages</li>
454
551
  <li>Build internal links between related docs</li>
455
552
  </ol>
553
+ <h2>External SEO Tools and Resources</h2>
554
+ <h3>Essential SEO Tools</h3>
555
+ <h4>1. <strong>Google Search Console</strong> - <a href="https://search.google.com/search-console">search.google.com/search-console</a></h4>
556
+ <ul>
557
+ <li>Monitor your documentation&#39;s search performance</li>
558
+ <li>Submit sitemaps for faster indexing</li>
559
+ <li>Find crawl errors and indexing issues</li>
560
+ <li>See which queries bring users to your docs</li>
561
+ <li><strong>Free tool from Google</strong></li>
562
+ </ul>
563
+ <h4>2. <strong>Google PageSpeed Insights</strong> - <a href="https://pagespeed.web.dev">pagespeed.web.dev</a></h4>
564
+ <ul>
565
+ <li>Test page load performance</li>
566
+ <li>Get specific optimization suggestions</li>
567
+ <li>Check Core Web Vitals scores</li>
568
+ <li>Mobile and desktop analysis</li>
569
+ <li><strong>Free tool</strong></li>
570
+ </ul>
571
+ <h4>3. <strong>Ahrefs Webmaster Tools</strong> - <a href="https://ahrefs.com/webmaster-tools">ahrefs.com/webmaster-tools</a></h4>
572
+ <ul>
573
+ <li>Free SEO health monitoring</li>
574
+ <li>Backlink analysis</li>
575
+ <li>Keyword rankings</li>
576
+ <li>Site audit features</li>
577
+ <li><strong>Free version available</strong></li>
578
+ </ul>
579
+ <h4>4. <strong>Schema Markup Validator</strong> - <a href="https://validator.schema.org">validator.schema.org</a></h4>
580
+ <ul>
581
+ <li>Validate your structured data</li>
582
+ <li>Test JSON-LD implementation</li>
583
+ <li>Find schema errors</li>
584
+ <li><strong>Free tool</strong></li>
585
+ </ul>
586
+ <h4>5. <strong>Open Graph Debugger</strong> - <a href="https://www.opengraph.xyz">opengraph.xyz</a></h4>
587
+ <ul>
588
+ <li>Preview how your docs appear on social media</li>
589
+ <li>Debug Open Graph tags</li>
590
+ <li>Test different URLs</li>
591
+ <li><strong>Free tool</strong></li>
592
+ </ul>
593
+ <h3>SEO Learning Resources</h3>
594
+ <h4>Beginner Resources</h4>
595
+ <ol>
596
+ <li><p><strong>Google SEO Starter Guide</strong> - <a href="https://developers.google.com/search/docs/fundamentals/seo-starter-guide">developers.google.com/search/docs/fundamentals/seo-starter-guide</a></p>
597
+ <ul>
598
+ <li>Official guide from Google</li>
599
+ <li>Covers all SEO basics</li>
600
+ <li>Best practices straight from the source</li>
601
+ </ul>
602
+ </li>
603
+ <li><p><strong>Moz Beginner&#39;s Guide to SEO</strong> - <a href="https://moz.com/beginners-guide-to-seo">moz.com/beginners-guide-to-seo</a></p>
604
+ <ul>
605
+ <li>Comprehensive 7-chapter guide</li>
606
+ <li>Visual explanations</li>
607
+ <li>Industry-standard resource</li>
608
+ </ul>
609
+ </li>
610
+ </ol>
611
+ <h4>Advanced Resources</h4>
612
+ <ol start="3">
613
+ <li><p><strong>Ahrefs SEO Guide</strong> - <a href="https://ahrefs.com/seo">ahrefs.com/seo</a></p>
614
+ <ul>
615
+ <li>Data-driven strategies</li>
616
+ <li>Advanced techniques</li>
617
+ <li>Case studies and examples</li>
618
+ </ul>
619
+ </li>
620
+ <li><p><strong>Search Engine Journal</strong> - <a href="https://searchenginejournal.com">searchenginejournal.com</a></p>
621
+ <ul>
622
+ <li>Latest SEO news and updates</li>
623
+ <li>Algorithm change analysis</li>
624
+ <li>Expert insights</li>
625
+ </ul>
626
+ </li>
627
+ <li><p><strong>Technical SEO Guide</strong> - <a href="https://developers.google.com/search/docs/advanced/guidelines">developers.google.com/search/docs/advanced/guidelines</a></p>
628
+ <ul>
629
+ <li>Google&#39;s technical requirements</li>
630
+ <li>Crawling and indexing details</li>
631
+ <li>Advanced implementation</li>
632
+ </ul>
633
+ </li>
634
+ </ol>
635
+ <h3>Keyword Research Tools</h3>
636
+ <ol>
637
+ <li><p><strong>Google Keyword Planner</strong> - <a href="https://ads.google.com/keywordplanner">ads.google.com/keywordplanner</a></p>
638
+ <ul>
639
+ <li>Free with Google Ads account</li>
640
+ <li>Search volume data</li>
641
+ <li>Keyword suggestions</li>
642
+ </ul>
643
+ </li>
644
+ <li><p><strong>Ubersuggest</strong> - <a href="https://neilpatel.com/ubersuggest">neilpatel.com/ubersuggest</a></p>
645
+ <ul>
646
+ <li>Free keyword research</li>
647
+ <li>Content ideas</li>
648
+ <li>Competitor analysis</li>
649
+ </ul>
650
+ </li>
651
+ <li><p><strong>Answer The Public</strong> - <a href="https://answerthepublic.com">answerthepublic.com</a></p>
652
+ <ul>
653
+ <li>Find questions people ask</li>
654
+ <li>Visual keyword research</li>
655
+ <li>Great for documentation topics</li>
656
+ </ul>
657
+ </li>
658
+ <li><p><strong>Google Trends</strong> - <a href="https://trends.google.com">trends.google.com</a></p>
659
+ <ul>
660
+ <li>Track keyword popularity over time</li>
661
+ <li>Compare search terms</li>
662
+ <li>Find rising topics</li>
663
+ </ul>
664
+ </li>
665
+ </ol>
666
+ <h3>Performance Testing</h3>
667
+ <ol>
668
+ <li><p><strong>GTmetrix</strong> - <a href="https://gtmetrix.com">gtmetrix.com</a></p>
669
+ <ul>
670
+ <li>Detailed performance reports</li>
671
+ <li>Waterfall charts</li>
672
+ <li>Historical tracking</li>
673
+ </ul>
674
+ </li>
675
+ <li><p><strong>WebPageTest</strong> - <a href="https://webpagetest.org">webpagetest.org</a></p>
676
+ <ul>
677
+ <li>Advanced performance testing</li>
678
+ <li>Multiple location testing</li>
679
+ <li>Video capture of page load</li>
680
+ </ul>
681
+ </li>
682
+ <li><p><strong>Lighthouse</strong> (Built into Chrome DevTools)</p>
683
+ <ul>
684
+ <li>Performance, SEO, and accessibility audits</li>
685
+ <li>Actionable recommendations</li>
686
+ <li>CLI version available</li>
687
+ </ul>
688
+ </li>
689
+ </ol>
690
+ <h3>Documentation-Specific SEO Tips</h3>
691
+ <p>According to <a href="https://developers.google.com/style/seo">Google&#39;s Documentation Best Practices</a>:</p>
692
+ <ol>
693
+ <li><strong>Use descriptive URLs</strong> - <code>/guides/authentication</code> not <code>/page1</code></li>
694
+ <li><strong>Create comprehensive content</strong> - Answer the full question</li>
695
+ <li><strong>Use code examples</strong> - Show, don&#39;t just tell</li>
696
+ <li><strong>Keep content fresh</strong> - Update regularly</li>
697
+ <li><strong>Internal linking</strong> - Connect related topics</li>
698
+ </ol>
456
699
  <h2>Quick Reference</h2>
457
700
  <h3>Front Matter Template</h3>
458
701
  <pre><code class="language-yaml">---
459
702
  title: &quot;Your SEO Optimized Title Here | Brand&quot;
460
703
  description: &quot;A compelling 140-160 character description that includes keywords and encourages clicks from search results.&quot;
461
704
  keywords: [&quot;primary keyword&quot;, &quot;secondary keyword&quot;, &quot;long-tail phrase&quot;]
705
+ author: &quot;Your Name&quot;
706
+ date: &quot;2025-01-22&quot;
462
707
  ---
463
708
  </code></pre>
464
709
  <h3>CLI Commands</h3>
465
- <pre><code class="language-bash"># Check SEO
710
+ <pre><code class="language-bash"># Build your documentation
711
+ doc-builder build
712
+
713
+ # Check SEO of generated HTML
466
714
  doc-builder seo-check
467
715
 
468
716
  # Add Google verification
469
717
  doc-builder google-verify YOUR_CODE
470
718
 
471
- # Build with SEO
472
- doc-builder build
719
+ # Deploy with SEO optimization
720
+ doc-builder deploy
473
721
  </code></pre>
722
+ <h3>SEO Checklist</h3>
723
+ <p>Before publishing:</p>
724
+ <ul>
725
+ <li><input disabled="" type="checkbox"> Run <code>doc-builder build</code> to generate HTML</li>
726
+ <li><input disabled="" type="checkbox"> Run <code>doc-builder seo-check</code> to find issues</li>
727
+ <li><input disabled="" type="checkbox"> Fix any critical SEO problems</li>
728
+ <li><input disabled="" type="checkbox"> Add front matter to important pages</li>
729
+ <li><input disabled="" type="checkbox"> Set production URL in config</li>
730
+ <li><input disabled="" type="checkbox"> Generate and submit sitemap</li>
731
+ <li><input disabled="" type="checkbox"> Set up Google Search Console</li>
732
+ <li><input disabled="" type="checkbox"> Add Google Analytics (optional)</li>
733
+ <li><input disabled="" type="checkbox"> Test social media previews</li>
734
+ <li><input disabled="" type="checkbox"> Check page load speed</li>
735
+ </ul>
736
+ <h2>Monitoring Success</h2>
737
+ <h3>Key Metrics to Track</h3>
738
+ <ol>
739
+ <li><strong>Organic Traffic</strong> - Visitors from search engines</li>
740
+ <li><strong>Search Impressions</strong> - How often you appear in results</li>
741
+ <li><strong>Click-Through Rate (CTR)</strong> - Percentage who click</li>
742
+ <li><strong>Average Position</strong> - Where you rank for keywords</li>
743
+ <li><strong>Page Load Time</strong> - Speed affects rankings</li>
744
+ </ol>
745
+ <h3>Tools for Monitoring</h3>
746
+ <ul>
747
+ <li><strong>Google Analytics 4</strong> - <a href="https://analytics.google.com">analytics.google.com</a></li>
748
+ <li><strong>Google Search Console</strong> - Track search performance</li>
749
+ <li><strong>Ahrefs/SEMrush</strong> - Competitive analysis</li>
750
+ <li><strong>Custom dashboards</strong> - Combine multiple data sources</li>
751
+ </ul>
474
752
  <h2>Next Steps</h2>
475
753
  <ol>
476
- <li>Add front matter to your important pages</li>
477
- <li>Run <code>seo-check</code> to identify issues</li>
478
- <li>Configure global SEO settings</li>
754
+ <li><p><strong>Immediate Actions</strong>:</p>
755
+ <ul>
756
+ <li>Add front matter to your top 10 pages</li>
757
+ <li>Run <code>seo-check</code> and fix critical issues</li>
479
758
  <li>Set up Google Search Console</li>
480
- <li>Monitor and optimize based on data</li>
759
+ </ul>
760
+ </li>
761
+ <li><p><strong>This Week</strong>:</p>
762
+ <ul>
763
+ <li>Optimize all page titles and descriptions</li>
764
+ <li>Submit sitemap to search engines</li>
765
+ <li>Test and fix page load speed</li>
766
+ </ul>
767
+ </li>
768
+ <li><p><strong>Ongoing</strong>:</p>
769
+ <ul>
770
+ <li>Monitor search performance weekly</li>
771
+ <li>Update content based on user queries</li>
772
+ <li>Build internal links between related docs</li>
773
+ <li>Keep content fresh and accurate</li>
774
+ </ul>
775
+ </li>
481
776
  </ol>
482
777
  <hr>
483
- <p>For more help, see the <a href="./google-site-verification-guide.md">Google Site Verification Guide</a> or run <code>doc-builder --help</code>.</p>
778
+ <p>For more help, see the <a href="./google-site-verification-guide.md">Google Site Verification Guide</a> or join the <a href="https://github.com/knowcode/doc-builder/discussions">doc-builder community</a>.</p>
484
779
 
485
780
  </div>
486
781
  </main>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.907Z",
65
- "dateModified": "2025-07-22T08:09:57.907Z",
64
+ "datePublished": "2025-07-22T08:32:13.141Z",
65
+ "dateModified": "2025-07-22T08:32:13.141Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
@@ -101,7 +101,7 @@
101
101
 
102
102
  <div class="header-actions">
103
103
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
104
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
105
  </div>
106
106
 
107
107
 
@@ -164,7 +164,7 @@
164
164
  <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>
165
165
  <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>
166
166
  <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>
167
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
167
+ <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>
168
168
  <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>
169
169
  </nav>
170
170
  <div class="resize-handle"></div>
package/html/index.html CHANGED
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.857Z",
65
- "dateModified": "2025-07-22T08:09:57.857Z",
64
+ "datePublished": "2025-07-22T08:32:13.098Z",
65
+ "dateModified": "2025-07-22T08:32:13.098Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/README.html"
@@ -95,7 +95,7 @@
95
95
 
96
96
  <div class="header-actions">
97
97
  <div class="deployment-info">
98
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
98
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
99
  </div>
100
100
 
101
101
 
@@ -158,7 +158,7 @@
158
158
  <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
159
  <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>
160
160
  <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
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
161
+ <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
162
  <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>
163
163
  </nav>
164
164
  <div class="resize-handle"></div>
package/html/sitemap.xml CHANGED
@@ -2,91 +2,91 @@
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:09:57.928Z</lastmod>
5
+ <lastmod>2025-07-22T08:32:13.156Z</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:09:57.928Z</lastmod>
11
+ <lastmod>2025-07-22T08:32:13.156Z</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:09:57.928Z</lastmod>
17
+ <lastmod>2025-07-22T08:32:13.156Z</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:09:57.928Z</lastmod>
23
+ <lastmod>2025-07-22T08:32:13.156Z</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:09:57.928Z</lastmod>
29
+ <lastmod>2025-07-22T08:32:13.156Z</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:09:57.928Z</lastmod>
35
+ <lastmod>2025-07-22T08:32:13.156Z</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:09:57.928Z</lastmod>
41
+ <lastmod>2025-07-22T08:32:13.156Z</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:09:57.928Z</lastmod>
47
+ <lastmod>2025-07-22T08:32:13.156Z</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:09:57.928Z</lastmod>
53
+ <lastmod>2025-07-22T08:32:13.156Z</lastmod>
54
54
  <changefreq>monthly</changefreq>
55
55
  <priority>0.8</priority>
56
56
  </url>
57
57
  <url>
58
58
  <loc>https://doc-builder-delta.vercel.app/guides/seo-guide.html</loc>
59
- <lastmod>2025-07-22T08:09:57.928Z</lastmod>
59
+ <lastmod>2025-07-22T08:32:13.156Z</lastmod>
60
60
  <changefreq>monthly</changefreq>
61
61
  <priority>0.8</priority>
62
62
  </url>
63
63
  <url>
64
64
  <loc>https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html</loc>
65
- <lastmod>2025-07-22T08:09:57.928Z</lastmod>
65
+ <lastmod>2025-07-22T08:32:13.156Z</lastmod>
66
66
  <changefreq>monthly</changefreq>
67
67
  <priority>0.8</priority>
68
68
  </url>
69
69
  <url>
70
70
  <loc>https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html</loc>
71
- <lastmod>2025-07-22T08:09:57.928Z</lastmod>
71
+ <lastmod>2025-07-22T08:32:13.156Z</lastmod>
72
72
  <changefreq>monthly</changefreq>
73
73
  <priority>0.8</priority>
74
74
  </url>
75
75
  <url>
76
76
  <loc>https://doc-builder-delta.vercel.app/index.html</loc>
77
- <lastmod>2025-07-22T08:09:57.928Z</lastmod>
77
+ <lastmod>2025-07-22T08:32:13.156Z</lastmod>
78
78
  <changefreq>weekly</changefreq>
79
79
  <priority>1.0</priority>
80
80
  </url>
81
81
  <url>
82
82
  <loc>https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html</loc>
83
- <lastmod>2025-07-22T08:09:57.928Z</lastmod>
83
+ <lastmod>2025-07-22T08:32:13.156Z</lastmod>
84
84
  <changefreq>monthly</changefreq>
85
85
  <priority>0.8</priority>
86
86
  </url>
87
87
  <url>
88
88
  <loc>https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html</loc>
89
- <lastmod>2025-07-22T08:09:57.928Z</lastmod>
89
+ <lastmod>2025-07-22T08:32:13.156Z</lastmod>
90
90
  <changefreq>monthly</changefreq>
91
91
  <priority>0.8</priority>
92
92
  </url>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.912Z",
65
- "dateModified": "2025-07-22T08:09:57.912Z",
64
+ "datePublished": "2025-07-22T08:32:13.144Z",
65
+ "dateModified": "2025-07-22T08:32:13.144Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html"
@@ -95,7 +95,7 @@
95
95
 
96
96
  <div class="header-actions">
97
97
  <div class="deployment-info">
98
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
98
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
99
  </div>
100
100
 
101
101
 
@@ -158,7 +158,7 @@
158
158
  <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
159
  <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>
160
160
  <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
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
161
+ <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
162
  <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>
163
163
  </nav>
164
164
  <div class="resize-handle"></div>
@@ -61,8 +61,8 @@
61
61
  "name": "Knowcode Ltd",
62
62
  "url": "https://knowcode.tech"
63
63
  },
64
- "datePublished": "2025-07-22T08:09:57.916Z",
65
- "dateModified": "2025-07-22T08:09:57.916Z",
64
+ "datePublished": "2025-07-22T08:32:13.147Z",
65
+ "dateModified": "2025-07-22T08:32:13.147Z",
66
66
  "mainEntityOfPage": {
67
67
  "@type": "WebPage",
68
68
  "@id": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html"
@@ -95,7 +95,7 @@
95
95
 
96
96
  <div class="header-actions">
97
97
  <div class="deployment-info">
98
- <span class="deployment-date" title="Built with doc-builder v1.5.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
98
+ <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
99
  </div>
100
100
 
101
101
 
@@ -158,7 +158,7 @@
158
158
  <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
159
  <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>
160
160
  <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
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Good SEO helps your documentation: Rank higher in search results Get more organic traffic Improve click-through rates Reach the right audience Build..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
161
+ <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
162
  <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>
163
163
  </nav>
164
164
  <div class="resize-handle"></div>
package/lib/config.js CHANGED
@@ -251,11 +251,15 @@ async function loadConfig(configPath, options = {}) {
251
251
  }
252
252
  }
253
253
 
254
- // Validate paths - but be lenient for deploy command
254
+ // Validate paths - but be lenient for commands that will create directories
255
255
  const docsPath = path.join(process.cwd(), config.docsDir);
256
256
  if (!fs.existsSync(docsPath)) {
257
- console.warn(chalk.yellow(`Warning: Documentation directory not found: ${config.docsDir}`));
258
- console.log(chalk.gray(`Create it with: mkdir ${config.docsDir} && echo "# Documentation" > ${config.docsDir}/README.md`));
257
+ // Only show warning for commands that don't auto-create the directory
258
+ // The build command will create it automatically
259
+ if (!options || !['build', 'dev', 'deploy'].includes(options.command)) {
260
+ console.warn(chalk.yellow(`Warning: Documentation directory not found: ${config.docsDir}`));
261
+ console.log(chalk.gray(`Create it with: mkdir ${config.docsDir} && echo "# Documentation" > ${config.docsDir}/README.md`));
262
+ }
259
263
  // Don't throw error - let commands handle missing directories appropriately
260
264
  }
261
265
 
@@ -672,6 +672,9 @@ async function buildDocumentation(config) {
672
672
  const packageJson = require('../package.json');
673
673
  console.log(chalk.blue(`📦 Using @knowcode/doc-builder v${packageJson.version}`));
674
674
 
675
+ // Ensure output directory exists
676
+ await fs.ensureDir(outputDir);
677
+
675
678
  // Check and create placeholder README.md if missing
676
679
  console.log(chalk.blue('📋 Checking documentation structure...'));
677
680
  const readmeGenerated = await createPlaceholderReadme(docsDir, config);
@@ -867,6 +870,17 @@ async function buildDocumentation(config) {
867
870
 
868
871
  // Create placeholder README.md if missing
869
872
  async function createPlaceholderReadme(docsDir, config) {
873
+ // Create docs directory if it doesn't exist
874
+ if (!fs.existsSync(docsDir)) {
875
+ try {
876
+ await fs.ensureDir(docsDir);
877
+ console.log(chalk.yellow(`📁 Created missing docs directory: ${docsDir}`));
878
+ } catch (error) {
879
+ console.error(chalk.red(`Error creating docs directory: ${error.message}`));
880
+ throw error;
881
+ }
882
+ }
883
+
870
884
  const readmePath = path.join(docsDir, 'README.md');
871
885
  const indexPath = path.join(docsDir, 'index.md');
872
886
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowcode/doc-builder",
3
- "version": "1.5.8",
3
+ "version": "1.5.10",
4
4
  "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
5
5
  "main": "index.js",
6
6
  "bin": {