@knowcode/doc-builder 1.5.8 → 1.5.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/html/README.html +4 -4
- package/html/documentation-index.html +4 -4
- package/html/guides/authentication-guide.html +4 -4
- package/html/guides/claude-workflow-guide.html +4 -4
- package/html/guides/documentation-standards.html +4 -4
- package/html/guides/google-site-verification-guide.html +4 -4
- package/html/guides/seo-guide.html +4 -4
- package/html/guides/seo-optimization-guide.html +338 -43
- package/html/guides/troubleshooting-guide.html +4 -4
- package/html/index.html +4 -4
- package/html/sitemap.xml +15 -15
- package/html/vercel-cli-setup-guide.html +4 -4
- package/html/vercel-first-time-setup-guide.html +4 -4
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,23 @@ 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.9] - 2025-07-22
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Comprehensive SEO Optimization Guide with extensive external resources
|
|
12
|
+
- Detailed explanations of all SEO features and how they work
|
|
13
|
+
- References to 20+ external SEO tools and learning resources
|
|
14
|
+
- Keyword research tools and performance testing recommendations
|
|
15
|
+
- SEO monitoring strategies and success metrics
|
|
16
|
+
- Actionable SEO checklist for documentation projects
|
|
17
|
+
|
|
18
|
+
### Documentation
|
|
19
|
+
- Created detailed guide explaining automatic meta tag generation
|
|
20
|
+
- Added sections on Open Graph Protocol and Twitter Cards
|
|
21
|
+
- Included structured data (JSON-LD) explanations
|
|
22
|
+
- Referenced Google's official SEO guidelines and best practices
|
|
23
|
+
- Added links to free SEO tools and validators
|
|
24
|
+
|
|
8
25
|
## [1.5.8] - 2025-07-22
|
|
9
26
|
|
|
10
27
|
### Changed
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:44.971Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:44.971Z",
|
|
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.
|
|
98
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:44.983Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:44.983Z",
|
|
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.
|
|
98
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:44.986Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:44.986Z",
|
|
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.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:44.989Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:44.989Z",
|
|
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.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:44.992Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:44.992Z",
|
|
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.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:45.000Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:45.000Z",
|
|
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.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:45.004Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:45.004Z",
|
|
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.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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="
|
|
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="
|
|
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="
|
|
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": "
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:45.018Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:45.018Z",
|
|
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.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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>
|
|
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'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"><!-- Page Title - Shows in browser tabs and search results -->
|
|
194
|
+
<title>Your Page Title | Site Name</title>
|
|
195
|
+
|
|
196
|
+
<!-- Meta Description - The snippet shown in search results -->
|
|
197
|
+
<meta name="description" content="Your page description here">
|
|
198
|
+
|
|
199
|
+
<!-- Keywords - Helps search engines understand topic relevance -->
|
|
200
|
+
<meta name="keywords" content="keyword1, keyword2, keyword3">
|
|
201
|
+
|
|
202
|
+
<!-- Author Information -->
|
|
203
|
+
<meta name="author" content="Your Name">
|
|
204
|
+
|
|
205
|
+
<!-- Canonical URL - Prevents duplicate content issues -->
|
|
206
|
+
<link rel="canonical" href="https://yoursite.com/page.html">
|
|
207
|
+
|
|
208
|
+
<!-- Language and Region -->
|
|
209
|
+
<meta property="og:locale" content="en_US">
|
|
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"><meta property="og:type" content="article">
|
|
214
|
+
<meta property="og:title" content="Page Title">
|
|
215
|
+
<meta property="og:description" content="Page description">
|
|
216
|
+
<meta property="og:url" content="https://yoursite.com/page.html">
|
|
217
|
+
<meta property="og:image" content="https://yoursite.com/og-image.png">
|
|
218
|
+
<meta property="og:site_name" content="Your Site Name">
|
|
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"><meta name="twitter:card" content="summary_large_image">
|
|
224
|
+
<meta name="twitter:site" content="@yourhandle">
|
|
225
|
+
<meta name="twitter:title" content="Page Title">
|
|
226
|
+
<meta name="twitter:description" content="Page description">
|
|
227
|
+
<meta name="twitter:image" content="https://yoursite.com/twitter-image.png">
|
|
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
|
+
"@context": "https://schema.org",
|
|
234
|
+
"@type": "TechArticle",
|
|
235
|
+
"headline": "Your Page Title",
|
|
236
|
+
"description": "Your page description",
|
|
237
|
+
"author": {
|
|
238
|
+
"@type": "Person",
|
|
239
|
+
"name": "Author Name"
|
|
240
|
+
},
|
|
241
|
+
"publisher": {
|
|
242
|
+
"@type": "Organization",
|
|
243
|
+
"name": "Your Organization",
|
|
244
|
+
"url": "https://yoursite.com"
|
|
245
|
+
},
|
|
246
|
+
"datePublished": "2025-01-22",
|
|
247
|
+
"dateModified": "2025-01-22",
|
|
248
|
+
"breadcrumb": {
|
|
249
|
+
"@type": "BreadcrumbList",
|
|
250
|
+
"itemListElement": [...]
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
</code></pre>
|
|
254
|
+
<p>Validate your structured data: <a href="https://search.google.com/test/rich-results">Google'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"><?xml version="1.0" encoding="UTF-8"?>
|
|
258
|
+
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|
259
|
+
<url>
|
|
260
|
+
<loc>https://yoursite.com/index.html</loc>
|
|
261
|
+
<lastmod>2025-01-22</lastmod>
|
|
262
|
+
<changefreq>weekly</changefreq>
|
|
263
|
+
<priority>1.0</priority>
|
|
264
|
+
</url>
|
|
265
|
+
<!-- More URLs -->
|
|
266
|
+
</urlset>
|
|
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
|
- "doc-builder security"
|
|
287
375
|
---
|
|
288
376
|
</code></pre>
|
|
289
|
-
<h2>Using the SEO Check Command</h2>
|
|
290
|
-
<p>
|
|
291
|
-
<pre><code class="language-bash">#
|
|
292
|
-
doc-builder
|
|
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're properly optimized:</p>
|
|
379
|
+
<pre><code class="language-bash"># First, build your documentation
|
|
380
|
+
doc-builder build
|
|
293
381
|
|
|
294
|
-
#
|
|
295
|
-
doc-builder seo-check
|
|
382
|
+
# Then analyze the generated HTML
|
|
383
|
+
doc-builder seo-check
|
|
296
384
|
|
|
297
|
-
#
|
|
298
|
-
doc-builder seo-check
|
|
385
|
+
# Check specific HTML file
|
|
386
|
+
doc-builder seo-check html/guide.html
|
|
299
387
|
</code></pre>
|
|
300
|
-
<h3>What It
|
|
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
|
|
303
|
-
<li
|
|
304
|
-
<li
|
|
305
|
-
<li
|
|
306
|
-
<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
|
|
405
|
+
Analyzed 14 files
|
|
314
406
|
|
|
315
407
|
❌ Found 2 issues:
|
|
316
408
|
|
|
317
|
-
guides/api.
|
|
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
|
-
|
|
413
|
+
setup.html:
|
|
414
|
+
Missing meta description
|
|
415
|
+
|
|
416
|
+
💡 8 suggestions:
|
|
322
417
|
|
|
323
|
-
|
|
324
|
-
guides/
|
|
325
|
-
|
|
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'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'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'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'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'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: "Your SEO Optimized Title Here | Brand"
|
|
460
703
|
description: "A compelling 140-160 character description that includes keywords and encourages clicks from search results."
|
|
461
704
|
keywords: ["primary keyword", "secondary keyword", "long-tail phrase"]
|
|
705
|
+
author: "Your Name"
|
|
706
|
+
date: "2025-01-22"
|
|
462
707
|
---
|
|
463
708
|
</code></pre>
|
|
464
709
|
<h3>CLI Commands</h3>
|
|
465
|
-
<pre><code class="language-bash">#
|
|
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
|
-
#
|
|
472
|
-
doc-builder
|
|
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>
|
|
477
|
-
<
|
|
478
|
-
<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
|
-
|
|
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
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:45.026Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:45.026Z",
|
|
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.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:44.971Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:44.971Z",
|
|
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.
|
|
98
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
5
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
11
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
17
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
23
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
29
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
35
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
41
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
47
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
53
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
59
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
65
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
71
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
77
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
83
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
89
|
+
<lastmod>2025-07-22T08:28:45.043Z</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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:45.030Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:45.030Z",
|
|
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.
|
|
98
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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:
|
|
65
|
-
"dateModified": "2025-07-22T08:
|
|
64
|
+
"datePublished": "2025-07-22T08:28:45.034Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:28:45.034Z",
|
|
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.
|
|
98
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.8">Last updated: Jul 22, 2025, 08:28 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'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="
|
|
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>
|