@knowcode/doc-builder 1.5.5 → 1.5.6
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 +6 -0
- package/cli.js +1 -0
- package/html/README.html +12 -11
- package/html/documentation-index.html +12 -11
- package/html/guides/authentication-guide.html +12 -11
- package/html/guides/claude-workflow-guide.html +12 -11
- package/html/guides/documentation-standards.html +12 -11
- package/html/guides/google-site-verification-guide.html +12 -11
- package/html/guides/seo-guide.html +12 -11
- package/html/guides/seo-optimization-guide.html +493 -0
- package/html/guides/troubleshooting-guide.html +12 -11
- package/html/index.html +12 -11
- package/html/sitemap.xml +20 -14
- package/html/vercel-cli-setup-guide.html +12 -11
- package/html/vercel-first-time-setup-guide.html +12 -11
- package/package.json +1 -1
|
@@ -0,0 +1,493 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
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.">
|
|
7
|
+
<title>SEO Optimization Guide for @knowcode/doc-builder</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, SEO, optimization">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html">
|
|
13
|
+
|
|
14
|
+
<!-- Open Graph / Facebook -->
|
|
15
|
+
<meta property="og:type" content="article">
|
|
16
|
+
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html">
|
|
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.">
|
|
19
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
+
<meta property="og:site_name" content="Doc Builder">
|
|
21
|
+
<meta property="og:locale" content="en_US">
|
|
22
|
+
|
|
23
|
+
<!-- Twitter Card -->
|
|
24
|
+
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
+
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
+
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
+
<meta name="twitter:title" content="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.">
|
|
29
|
+
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
|
+
|
|
31
|
+
<!-- Custom Meta Tags -->
|
|
32
|
+
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
|
|
34
|
+
<!-- Fonts -->
|
|
35
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
36
|
+
|
|
37
|
+
<!-- Icons -->
|
|
38
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
39
|
+
|
|
40
|
+
<!-- Mermaid -->
|
|
41
|
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
42
|
+
|
|
43
|
+
<!-- Styles -->
|
|
44
|
+
<link rel="stylesheet" href="/css/notion-style.css">
|
|
45
|
+
|
|
46
|
+
<!-- Favicon -->
|
|
47
|
+
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
48
|
+
|
|
49
|
+
<script type="application/ld+json">
|
|
50
|
+
{
|
|
51
|
+
"@context": "https://schema.org",
|
|
52
|
+
"@type": "TechArticle",
|
|
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.",
|
|
55
|
+
"author": {
|
|
56
|
+
"@type": "Person",
|
|
57
|
+
"name": "Lindsay Smith"
|
|
58
|
+
},
|
|
59
|
+
"publisher": {
|
|
60
|
+
"@type": "Organization",
|
|
61
|
+
"name": "Knowcode Ltd",
|
|
62
|
+
"url": "https://knowcode.tech"
|
|
63
|
+
},
|
|
64
|
+
"datePublished": "2025-07-22T08:09:57.904Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:09:57.904Z",
|
|
66
|
+
"mainEntityOfPage": {
|
|
67
|
+
"@type": "WebPage",
|
|
68
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
|
|
69
|
+
},
|
|
70
|
+
"breadcrumb": {
|
|
71
|
+
"@type": "BreadcrumbList",
|
|
72
|
+
"itemListElement": [
|
|
73
|
+
{
|
|
74
|
+
"@type": "ListItem",
|
|
75
|
+
"position": 1,
|
|
76
|
+
"name": "Doc Builder",
|
|
77
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"@type": "ListItem",
|
|
81
|
+
"position": 2,
|
|
82
|
+
"name": "Guides",
|
|
83
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"@type": "ListItem",
|
|
87
|
+
"position": 3,
|
|
88
|
+
"name": "Seo Optimization Guide",
|
|
89
|
+
"item": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
|
|
90
|
+
}
|
|
91
|
+
]
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
</script>
|
|
95
|
+
</head>
|
|
96
|
+
<body>
|
|
97
|
+
<!-- Header -->
|
|
98
|
+
<header class="header">
|
|
99
|
+
<div class="header-content">
|
|
100
|
+
<a href="/index.html" class="logo">Doc Builder</a>
|
|
101
|
+
|
|
102
|
+
<div class="header-actions">
|
|
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>
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
110
|
+
<i class="fas fa-moon"></i>
|
|
111
|
+
</button>
|
|
112
|
+
|
|
113
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
114
|
+
<i class="fas fa-bars"></i>
|
|
115
|
+
</button>
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
</header>
|
|
119
|
+
|
|
120
|
+
<!-- Preview Banner -->
|
|
121
|
+
<div id="preview-banner" class="preview-banner">
|
|
122
|
+
<div class="banner-content">
|
|
123
|
+
<i class="fas fa-exclamation-triangle banner-icon"></i>
|
|
124
|
+
<span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
|
|
125
|
+
<button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
|
|
126
|
+
<i class="fas fa-times"></i>
|
|
127
|
+
</button>
|
|
128
|
+
</div>
|
|
129
|
+
</div>
|
|
130
|
+
|
|
131
|
+
<!-- Breadcrumbs -->
|
|
132
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
133
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
134
|
+
</nav>
|
|
135
|
+
|
|
136
|
+
<!-- Main Content -->
|
|
137
|
+
<div class="main-wrapper">
|
|
138
|
+
<!-- Sidebar -->
|
|
139
|
+
<aside class="sidebar">
|
|
140
|
+
<div class="sidebar-header">
|
|
141
|
+
<div class="filter-box">
|
|
142
|
+
<input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
|
|
143
|
+
<i class="fas fa-search filter-icon"></i>
|
|
144
|
+
</div>
|
|
145
|
+
</div>
|
|
146
|
+
<nav class="navigation">
|
|
147
|
+
|
|
148
|
+
<div class="nav-section" data-level="0">
|
|
149
|
+
<a class="nav-title" href="/README.html" >
|
|
150
|
+
<i class="fas fa-home"></i> Documentation
|
|
151
|
+
</a>
|
|
152
|
+
<div class="nav-content" >
|
|
153
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
154
|
+
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
155
|
+
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
156
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you'll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
157
|
+
<div class="nav-section" data-level="1">
|
|
158
|
+
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
159
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
160
|
+
</a>
|
|
161
|
+
<div class="nav-content" id="nav-guides-1">
|
|
162
|
+
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
163
|
+
<a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
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
|
+
<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
|
+
<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>
|
|
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
|
+
</nav>
|
|
170
|
+
<div class="resize-handle"></div>
|
|
171
|
+
</aside>
|
|
172
|
+
|
|
173
|
+
<!-- Content Area -->
|
|
174
|
+
<main class="content">
|
|
175
|
+
<div class="content-inner">
|
|
176
|
+
<h1>SEO Optimization Guide</h1>
|
|
177
|
+
<p>This guide explains how to optimize your documentation for search engines using @knowcode/doc-builder's advanced SEO features.</p>
|
|
178
|
+
<h2>Overview</h2>
|
|
179
|
+
<p>Good SEO helps your documentation:</p>
|
|
180
|
+
<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>
|
|
186
|
+
</ul>
|
|
187
|
+
<h2>Front Matter Support (v1.5.5+)</h2>
|
|
188
|
+
<p>@knowcode/doc-builder now supports YAML front matter for page-specific SEO customization:</p>
|
|
189
|
+
<pre><code class="language-yaml">---
|
|
190
|
+
title: "Complete Guide to Authentication | @knowcode/doc-builder"
|
|
191
|
+
description: "Learn how to secure your documentation with password protection. Step-by-step guide with code examples and best practices."
|
|
192
|
+
keywords: ["authentication", "security", "password protection", "doc-builder", "documentation"]
|
|
193
|
+
---
|
|
194
|
+
</code></pre>
|
|
195
|
+
<h3>Priority System</h3>
|
|
196
|
+
<p>SEO fields are determined by priority:</p>
|
|
197
|
+
<ol>
|
|
198
|
+
<li><strong>Title</strong>: Front matter → H1 heading → Filename</li>
|
|
199
|
+
<li><strong>Description</strong>: Front matter → Smart extraction → First paragraph</li>
|
|
200
|
+
<li><strong>Keywords</strong>: Front matter + Content extraction + Global keywords</li>
|
|
201
|
+
</ol>
|
|
202
|
+
<h2>Title Optimization</h2>
|
|
203
|
+
<h3>Best Practices (2025 Standards)</h3>
|
|
204
|
+
<ol>
|
|
205
|
+
<li><strong>Length</strong>: Keep titles between 50-60 characters</li>
|
|
206
|
+
<li><strong>Keywords First</strong>: Place primary keywords at the beginning</li>
|
|
207
|
+
<li><strong>Branding</strong>: Use customizable title templates</li>
|
|
208
|
+
<li><strong>Unique</strong>: Each page should have a unique title</li>
|
|
209
|
+
</ol>
|
|
210
|
+
<h3>Title Templates</h3>
|
|
211
|
+
<p>Configure title format in <code>doc-builder.config.js</code>:</p>
|
|
212
|
+
<pre><code class="language-javascript">seo: {
|
|
213
|
+
titleTemplate: '{pageTitle} | {siteName}', // Default
|
|
214
|
+
// or
|
|
215
|
+
titleTemplate: '{pageTitle} - {siteName} Docs',
|
|
216
|
+
// or
|
|
217
|
+
titleTemplate: '{siteName}: {pageTitle}'
|
|
218
|
+
}
|
|
219
|
+
</code></pre>
|
|
220
|
+
<h3>Examples</h3>
|
|
221
|
+
<p>Good titles:</p>
|
|
222
|
+
<ul>
|
|
223
|
+
<li>✅ "Authentication Guide | Doc Builder" (38 chars)</li>
|
|
224
|
+
<li>✅ "SEO Best Practices for Documentation | MyDocs" (45 chars)</li>
|
|
225
|
+
<li>✅ "Quick Start: Deploy to Vercel | Doc Builder" (43 chars)</li>
|
|
226
|
+
</ul>
|
|
227
|
+
<p>Bad titles:</p>
|
|
228
|
+
<ul>
|
|
229
|
+
<li>❌ "Guide" (5 chars - too short)</li>
|
|
230
|
+
<li>❌ "The Complete Comprehensive Guide to Setting Up Authentication and Security for Your Documentation Website | Doc Builder" (118 chars - too long)</li>
|
|
231
|
+
<li>❌ "Page Title | Site Name | Category | Subcategory" (keyword stuffing)</li>
|
|
232
|
+
</ul>
|
|
233
|
+
<h2>Meta Descriptions</h2>
|
|
234
|
+
<h3>Best Practices</h3>
|
|
235
|
+
<ol>
|
|
236
|
+
<li><strong>Length</strong>: 140-160 characters (ideal for 2025)</li>
|
|
237
|
+
<li><strong>Action-Oriented</strong>: Include call-to-action</li>
|
|
238
|
+
<li><strong>Keywords</strong>: Natural keyword inclusion</li>
|
|
239
|
+
<li><strong>Unique</strong>: Avoid duplicate descriptions</li>
|
|
240
|
+
<li><strong>Value Proposition</strong>: Explain what users will learn</li>
|
|
241
|
+
</ol>
|
|
242
|
+
<h3>Smart Description Extraction</h3>
|
|
243
|
+
<p>Doc-builder uses intelligent extraction:</p>
|
|
244
|
+
<ol>
|
|
245
|
+
<li>Checks for front matter description</li>
|
|
246
|
+
<li>Looks for intro paragraph after H1</li>
|
|
247
|
+
<li>Falls back to first paragraph</li>
|
|
248
|
+
<li>Ensures optimal length with word boundaries</li>
|
|
249
|
+
</ol>
|
|
250
|
+
<h3>Examples</h3>
|
|
251
|
+
<p>Good descriptions:</p>
|
|
252
|
+
<ul>
|
|
253
|
+
<li>✅ "Learn how to implement authentication in your documentation site. Step-by-step guide with code examples and security best practices." (139 chars)</li>
|
|
254
|
+
<li>✅ "Optimize your documentation for search engines with our comprehensive SEO guide. Covers titles, descriptions, and keyword strategies." (143 chars)</li>
|
|
255
|
+
</ul>
|
|
256
|
+
<p>Bad descriptions:</p>
|
|
257
|
+
<ul>
|
|
258
|
+
<li>❌ "This page is about authentication." (35 chars - too short)</li>
|
|
259
|
+
<li>❌ "Authentication authentication authentication..." (keyword stuffing)</li>
|
|
260
|
+
</ul>
|
|
261
|
+
<h2>Keywords Strategy</h2>
|
|
262
|
+
<h3>Modern Keyword Approach (2025)</h3>
|
|
263
|
+
<ol>
|
|
264
|
+
<li><strong>Topic Clusters</strong>: Focus on related topics, not single keywords</li>
|
|
265
|
+
<li><strong>User Intent</strong>: Answer specific questions</li>
|
|
266
|
+
<li><strong>Long-tail Keywords</strong>: Target conversational phrases</li>
|
|
267
|
+
<li><strong>Natural Language</strong>: Write for humans, not algorithms</li>
|
|
268
|
+
</ol>
|
|
269
|
+
<h3>Configuration</h3>
|
|
270
|
+
<pre><code class="language-javascript">seo: {
|
|
271
|
+
autoKeywords: true, // Extract from content
|
|
272
|
+
keywordLimit: 7, // Max per page
|
|
273
|
+
keywords: [ // Global keywords
|
|
274
|
+
"documentation",
|
|
275
|
+
"static site",
|
|
276
|
+
"vercel"
|
|
277
|
+
]
|
|
278
|
+
}
|
|
279
|
+
</code></pre>
|
|
280
|
+
<h3>Front Matter Keywords</h3>
|
|
281
|
+
<pre><code class="language-yaml">---
|
|
282
|
+
keywords:
|
|
283
|
+
- "authentication guide"
|
|
284
|
+
- "secure documentation"
|
|
285
|
+
- "password protection"
|
|
286
|
+
- "doc-builder security"
|
|
287
|
+
---
|
|
288
|
+
</code></pre>
|
|
289
|
+
<h2>Using the SEO Check Command</h2>
|
|
290
|
+
<p>Analyze your documentation's SEO:</p>
|
|
291
|
+
<pre><code class="language-bash"># Check all pages
|
|
292
|
+
doc-builder seo-check
|
|
293
|
+
|
|
294
|
+
# Check specific page
|
|
295
|
+
doc-builder seo-check docs/guide.md
|
|
296
|
+
|
|
297
|
+
# Auto-fix issues (coming soon)
|
|
298
|
+
doc-builder seo-check --fix
|
|
299
|
+
</code></pre>
|
|
300
|
+
<h3>What It Checks</h3>
|
|
301
|
+
<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>
|
|
307
|
+
</ul>
|
|
308
|
+
<h3>Example Output</h3>
|
|
309
|
+
<pre><code>🔍 Analyzing SEO...
|
|
310
|
+
|
|
311
|
+
📊 SEO Analysis Complete
|
|
312
|
+
|
|
313
|
+
Analyzed 10 files
|
|
314
|
+
|
|
315
|
+
❌ Found 2 issues:
|
|
316
|
+
|
|
317
|
+
guides/api.md:
|
|
318
|
+
Title too long (75 chars, max 60)
|
|
319
|
+
Suggestion: API Reference Documentation for Doc Build...
|
|
320
|
+
|
|
321
|
+
💡 5 suggestions:
|
|
322
|
+
|
|
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
|
|
326
|
+
</code></pre>
|
|
327
|
+
<h2>Advanced Configuration</h2>
|
|
328
|
+
<h3>Per-Page Customization</h3>
|
|
329
|
+
<p>Each markdown file can have custom SEO:</p>
|
|
330
|
+
<pre><code class="language-markdown">---
|
|
331
|
+
title: "Custom Page Title for SEO"
|
|
332
|
+
description: "Override the auto-generated description with this custom one that's perfectly optimized."
|
|
333
|
+
keywords: ["specific", "page", "keywords"]
|
|
334
|
+
---
|
|
335
|
+
|
|
336
|
+
# Different H1 for Display
|
|
337
|
+
|
|
338
|
+
Your content here...
|
|
339
|
+
</code></pre>
|
|
340
|
+
<h3>Global SEO Settings</h3>
|
|
341
|
+
<p>Configure in <code>doc-builder.config.js</code>:</p>
|
|
342
|
+
<pre><code class="language-javascript">module.exports = {
|
|
343
|
+
siteName: 'My Documentation',
|
|
344
|
+
siteDescription: 'Default description for all pages',
|
|
345
|
+
|
|
346
|
+
seo: {
|
|
347
|
+
enabled: true,
|
|
348
|
+
siteUrl: 'https://docs.example.com',
|
|
349
|
+
author: 'Your Name',
|
|
350
|
+
twitterHandle: '@yourhandle',
|
|
351
|
+
language: 'en-US',
|
|
352
|
+
|
|
353
|
+
// Title customization
|
|
354
|
+
titleTemplate: '{pageTitle} | {siteName}',
|
|
355
|
+
|
|
356
|
+
// Description settings
|
|
357
|
+
descriptionFallback: 'smart', // or 'first-paragraph'
|
|
358
|
+
|
|
359
|
+
// Keywords
|
|
360
|
+
keywords: ['documentation', 'guides'],
|
|
361
|
+
autoKeywords: true,
|
|
362
|
+
keywordLimit: 7,
|
|
363
|
+
|
|
364
|
+
// Organization
|
|
365
|
+
organization: {
|
|
366
|
+
name: 'Your Company',
|
|
367
|
+
url: 'https://example.com',
|
|
368
|
+
logo: 'https://example.com/logo.png'
|
|
369
|
+
},
|
|
370
|
+
|
|
371
|
+
// Social
|
|
372
|
+
ogImage: '/og-default.png',
|
|
373
|
+
|
|
374
|
+
// Technical
|
|
375
|
+
generateSitemap: true,
|
|
376
|
+
generateRobotsTxt: true,
|
|
377
|
+
customMetaTags: []
|
|
378
|
+
}
|
|
379
|
+
};
|
|
380
|
+
</code></pre>
|
|
381
|
+
<h2>Common SEO Mistakes to Avoid</h2>
|
|
382
|
+
<h3>1. Duplicate Content</h3>
|
|
383
|
+
<ul>
|
|
384
|
+
<li>❌ Same description on multiple pages</li>
|
|
385
|
+
<li>✅ Unique descriptions for each page</li>
|
|
386
|
+
</ul>
|
|
387
|
+
<h3>2. Keyword Stuffing</h3>
|
|
388
|
+
<ul>
|
|
389
|
+
<li>❌ "Guide guide documentation guide tutorial guide"</li>
|
|
390
|
+
<li>✅ Natural keyword usage in context</li>
|
|
391
|
+
</ul>
|
|
392
|
+
<h3>3. Ignoring Mobile</h3>
|
|
393
|
+
<ul>
|
|
394
|
+
<li>❌ Long titles that get cut off on mobile</li>
|
|
395
|
+
<li>✅ Test how titles appear on different devices</li>
|
|
396
|
+
</ul>
|
|
397
|
+
<h3>4. Missing Descriptions</h3>
|
|
398
|
+
<ul>
|
|
399
|
+
<li>❌ Leaving description blank</li>
|
|
400
|
+
<li>✅ Always provide meaningful descriptions</li>
|
|
401
|
+
</ul>
|
|
402
|
+
<h3>5. Generic Titles</h3>
|
|
403
|
+
<ul>
|
|
404
|
+
<li>❌ "Documentation", "Guide", "Page 1"</li>
|
|
405
|
+
<li>✅ Specific, descriptive titles</li>
|
|
406
|
+
</ul>
|
|
407
|
+
<h2>SEO Checklist</h2>
|
|
408
|
+
<p>Before publishing, ensure:</p>
|
|
409
|
+
<ul>
|
|
410
|
+
<li><input disabled="" type="checkbox"> All pages have unique titles (50-60 chars)</li>
|
|
411
|
+
<li><input disabled="" type="checkbox"> All pages have meta descriptions (140-160 chars)</li>
|
|
412
|
+
<li><input disabled="" type="checkbox"> Important pages have front matter SEO</li>
|
|
413
|
+
<li><input disabled="" type="checkbox"> Run <code>doc-builder seo-check</code> and fix issues</li>
|
|
414
|
+
<li><input disabled="" type="checkbox"> Set <code>seo.siteUrl</code> in config for proper URLs</li>
|
|
415
|
+
<li><input disabled="" type="checkbox"> Verify Google site ownership with <code>google-verify</code></li>
|
|
416
|
+
<li><input disabled="" type="checkbox"> Submit sitemap.xml to Google Search Console</li>
|
|
417
|
+
<li><input disabled="" type="checkbox"> Test mobile appearance</li>
|
|
418
|
+
</ul>
|
|
419
|
+
<h2>Best Practices for 2025</h2>
|
|
420
|
+
<h3>AI and Semantic Search</h3>
|
|
421
|
+
<ul>
|
|
422
|
+
<li>Write for topic clusters, not just keywords</li>
|
|
423
|
+
<li>Focus on user intent and questions</li>
|
|
424
|
+
<li>Use natural, conversational language</li>
|
|
425
|
+
<li>Structure content with clear hierarchies</li>
|
|
426
|
+
</ul>
|
|
427
|
+
<h3>Technical Excellence</h3>
|
|
428
|
+
<ul>
|
|
429
|
+
<li>Ensure fast page load times</li>
|
|
430
|
+
<li>Use structured data (automatic with doc-builder)</li>
|
|
431
|
+
<li>Implement proper heading hierarchy</li>
|
|
432
|
+
<li>Include alt text for images</li>
|
|
433
|
+
</ul>
|
|
434
|
+
<h3>Content Quality</h3>
|
|
435
|
+
<ul>
|
|
436
|
+
<li>Write comprehensive, valuable content</li>
|
|
437
|
+
<li>Update regularly to maintain freshness</li>
|
|
438
|
+
<li>Include examples and practical applications</li>
|
|
439
|
+
<li>Link to related documentation</li>
|
|
440
|
+
</ul>
|
|
441
|
+
<h2>Monitoring and Improvement</h2>
|
|
442
|
+
<h3>Track Performance</h3>
|
|
443
|
+
<ol>
|
|
444
|
+
<li>Set up Google Search Console</li>
|
|
445
|
+
<li>Monitor search impressions and clicks</li>
|
|
446
|
+
<li>Track ranking positions</li>
|
|
447
|
+
<li>Analyze user queries</li>
|
|
448
|
+
</ol>
|
|
449
|
+
<h3>Continuous Optimization</h3>
|
|
450
|
+
<ol>
|
|
451
|
+
<li>Update titles based on performance</li>
|
|
452
|
+
<li>A/B test different descriptions</li>
|
|
453
|
+
<li>Expand content for high-value pages</li>
|
|
454
|
+
<li>Build internal links between related docs</li>
|
|
455
|
+
</ol>
|
|
456
|
+
<h2>Quick Reference</h2>
|
|
457
|
+
<h3>Front Matter Template</h3>
|
|
458
|
+
<pre><code class="language-yaml">---
|
|
459
|
+
title: "Your SEO Optimized Title Here | Brand"
|
|
460
|
+
description: "A compelling 140-160 character description that includes keywords and encourages clicks from search results."
|
|
461
|
+
keywords: ["primary keyword", "secondary keyword", "long-tail phrase"]
|
|
462
|
+
---
|
|
463
|
+
</code></pre>
|
|
464
|
+
<h3>CLI Commands</h3>
|
|
465
|
+
<pre><code class="language-bash"># Check SEO
|
|
466
|
+
doc-builder seo-check
|
|
467
|
+
|
|
468
|
+
# Add Google verification
|
|
469
|
+
doc-builder google-verify YOUR_CODE
|
|
470
|
+
|
|
471
|
+
# Build with SEO
|
|
472
|
+
doc-builder build
|
|
473
|
+
</code></pre>
|
|
474
|
+
<h2>Next Steps</h2>
|
|
475
|
+
<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>
|
|
479
|
+
<li>Set up Google Search Console</li>
|
|
480
|
+
<li>Monitor and optimize based on data</li>
|
|
481
|
+
</ol>
|
|
482
|
+
<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>
|
|
484
|
+
|
|
485
|
+
</div>
|
|
486
|
+
</main>
|
|
487
|
+
</div>
|
|
488
|
+
|
|
489
|
+
<!-- Scripts -->
|
|
490
|
+
<script src="/js/main.js"></script>
|
|
491
|
+
|
|
492
|
+
</body>
|
|
493
|
+
</html>
|
|
@@ -3,19 +3,19 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>Troubleshooting Guide for @knowcode/doc-builder
|
|
6
|
+
<meta name="description" content="Generated: 2025-07-21 19:15 UTC">
|
|
7
|
+
<title>Troubleshooting Guide for @knowcode/doc-builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, issues, check
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, issues, check">
|
|
11
11
|
<meta name="robots" content="index, follow">
|
|
12
12
|
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html">
|
|
13
13
|
|
|
14
14
|
<!-- Open Graph / Facebook -->
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html">
|
|
17
|
-
<meta property="og:title" content="Troubleshooting Guide for @knowcode/doc-builder
|
|
18
|
-
<meta property="og:description" content="
|
|
17
|
+
<meta property="og:title" content="Troubleshooting Guide for @knowcode/doc-builder">
|
|
18
|
+
<meta property="og:description" content="Generated: 2025-07-21 19:15 UTC">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -24,8 +24,8 @@
|
|
|
24
24
|
<meta name="twitter:card" content="summary_large_image">
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Troubleshooting Guide for @knowcode/doc-builder
|
|
28
|
-
<meta name="twitter:description" content="
|
|
27
|
+
<meta name="twitter:title" content="Troubleshooting Guide for @knowcode/doc-builder">
|
|
28
|
+
<meta name="twitter:description" content="Generated: 2025-07-21 19:15 UTC">
|
|
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": "Troubleshooting Guide for @knowcode/doc-builder",
|
|
54
|
-
"description": "
|
|
54
|
+
"description": "Generated: 2025-07-21 19:15 UTC",
|
|
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-
|
|
65
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T08:09:57.907Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:09:57.907Z",
|
|
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.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
|
|
105
105
|
</div>
|
|
106
106
|
|
|
107
107
|
|
|
@@ -164,6 +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="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
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>
|
|
168
169
|
</nav>
|
|
169
170
|
<div class="resize-handle"></div>
|
package/html/index.html
CHANGED
|
@@ -3,19 +3,19 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>@knowcode/doc-builder
|
|
6
|
+
<meta name="description" content="> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling.">
|
|
7
|
+
<title>@knowcode/doc-builder | Doc Builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, knowcode
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, knowcode">
|
|
11
11
|
<meta name="robots" content="index, follow">
|
|
12
12
|
<link rel="canonical" href="https://doc-builder-delta.vercel.app/README.html">
|
|
13
13
|
|
|
14
14
|
<!-- Open Graph / Facebook -->
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/README.html">
|
|
17
|
-
<meta property="og:title" content="@knowcode/doc-builder
|
|
18
|
-
<meta property="og:description" content="
|
|
17
|
+
<meta property="og:title" content="@knowcode/doc-builder | Doc Builder">
|
|
18
|
+
<meta property="og:description" content="> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling.">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -24,8 +24,8 @@
|
|
|
24
24
|
<meta name="twitter:card" content="summary_large_image">
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="@knowcode/doc-builder
|
|
28
|
-
<meta name="twitter:description" content="
|
|
27
|
+
<meta name="twitter:title" content="@knowcode/doc-builder | Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling.">
|
|
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": "@knowcode/doc-builder",
|
|
54
|
-
"description": "
|
|
54
|
+
"description": "> Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling.",
|
|
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-
|
|
65
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T08:09:57.857Z",
|
|
65
|
+
"dateModified": "2025-07-22T08:09:57.857Z",
|
|
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.5">Last updated: Jul 22, 2025, 08:09 AM UTC</span>
|
|
99
99
|
</div>
|
|
100
100
|
|
|
101
101
|
|
|
@@ -158,6 +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="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
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>
|
|
162
163
|
</nav>
|
|
163
164
|
<div class="resize-handle"></div>
|