@knowcode/doc-builder 1.9.30 → 1.9.31
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/package.json +12 -2
- package/.claude/settings.local.json +0 -56
- package/CACHE-BUSTING-GUIDE.md +0 -82
- package/CLAUDE.md +0 -86
- package/CONTRIBUTING.md +0 -148
- package/GITHUB_SETUP.md +0 -203
- package/RELEASE-NOTES-1.7.5.md +0 -64
- package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
- package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
- package/add-user-clive.sql +0 -35
- package/add-user-lindsay-fixed.sql +0 -85
- package/add-user-lindsay.sql +0 -68
- package/add-user-pmorgan.sql +0 -35
- package/add-user-robbie.sql +0 -35
- package/add-wru-users.sql +0 -105
- package/debug-login.sql +0 -30
- package/doc-builder.config.js +0 -126
- package/doc-builder.config.js.backup.1753793768283 +0 -47
- package/doc-builder.config.js.backup.1753803964423 +0 -114
- package/doc-builder.config.js.backup.1753945707032 +0 -115
- package/doc-builder.config.js.backup.1754059241330 +0 -115
- package/doc-builder.config.js.backup.1754119567787 +0 -123
- package/doc-builder.config.js.backup.1754120048862 +0 -124
- package/doc-builder.config.js.backup.1754120529913 +0 -124
- package/doc-builder.config.js.backup.1754218469785 +0 -124
- package/doc-builder.config.js.backup.1754384764054 +0 -124
- package/doc-builder.config.js.backup.1754567425847 +0 -124
- package/doc-builder.config.js.backup.1754568137859 +0 -126
- package/doc-builder.config.js.backup.1754569388252 +0 -126
- package/doc-builder.config.js.backup.1754576694123 +0 -126
- package/doc-builder.config.js.backup.1755031374829 +0 -126
- package/doc-builder.config.js.backup.1755034500990 +0 -126
- package/doc-builder.config.js.backup.1755034809236 +0 -126
- package/grant-access.sql +0 -15
- package/html/11.png +0 -0
- package/html/404.html +0 -115
- package/html/README.html +0 -522
- package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
- package/html/about-doc-builder.html +0 -491
- package/html/auth.js +0 -157
- package/html/claude-workflow-guide.html +0 -525
- package/html/css/notion-style.css +0 -2502
- package/html/documentation-index.html +0 -471
- package/html/guides/authentication-default-change.html +0 -370
- package/html/guides/authentication-guide.html +0 -509
- package/html/guides/cache-control-anti-pattern.html +0 -361
- package/html/guides/claude-workflow-guide.html +0 -1074
- package/html/guides/configuration-guide.html +0 -472
- package/html/guides/document-standards.html +0 -518
- package/html/guides/documentation-standards.html +0 -694
- package/html/guides/html-embedding-guide.html +0 -461
- package/html/guides/image-modal-guide.html +0 -515
- package/html/guides/next-steps-walkthrough.html +0 -638
- package/html/guides/phosphor-icons-guide.html +0 -584
- package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
- package/html/guides/private-directory-authentication.html +0 -541
- package/html/guides/public-site-deployment.html +0 -431
- package/html/guides/search-engine-verification-guide.html +0 -542
- package/html/guides/seo-guide.html +0 -661
- package/html/guides/seo-optimization-guide.html +0 -887
- package/html/guides/supabase-auth-implementation-plan.html +0 -543
- package/html/guides/supabase-auth-integration-plan.html +0 -671
- package/html/guides/supabase-auth-setup-guide.html +0 -498
- package/html/guides/supabase-authentication-complete-guide.html +0 -866
- package/html/guides/troubleshooting-guide.html +0 -633
- package/html/guides/vercel-deployment-auth-setup.html +0 -337
- package/html/guides/windows-setup-guide.html +0 -859
- package/html/image-modal-test.html +0 -318
- package/html/index.html +0 -522
- package/html/js/auth.js +0 -157
- package/html/js/main.js +0 -1754
- package/html/launch/README.html +0 -297
- package/html/launch/bubble-plugin-specification.html +0 -933
- package/html/launch/go-to-market-strategy.html +0 -663
- package/html/launch/launch-announcements.html +0 -593
- package/html/login.html +0 -102
- package/html/logout.html +0 -18
- package/html/private/cache-control-anti-pattern.html +0 -429
- package/html/private/launch/README.html +0 -371
- package/html/private/launch/auth-cleanup-summary.html +0 -361
- package/html/private/launch/bubble-plugin-specification.html +0 -1007
- package/html/private/launch/go-to-market-strategy.html +0 -737
- package/html/private/launch/launch-announcements.html +0 -667
- package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
- package/html/private/next-steps-walkthrough.html +0 -679
- package/html/private/supabase-auth-implementation-completed.html +0 -454
- package/html/private/supabase-auth-implementation-plan.html +0 -594
- package/html/private/supabase-auth-integration-plan.html +0 -704
- package/html/private/supabase-auth-setup-guide.html +0 -555
- package/html/private/test-private-doc.html +0 -302
- package/html/private/user-management-tooling.html +0 -601
- package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
- package/html/prompts/beautiful-documentation-design.html +0 -784
- package/html/prompts/markdown-document-standards.html +0 -422
- package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
- package/html/robots.txt +0 -9
- package/html/sitemap.xml +0 -357
- package/html/test-questions/how-does-it-work%3F.html +0 -294
- package/html/test-questions/step-1%3A%20getting-started.html +0 -289
- package/html/test-questions/what-is-the-purpose.html +0 -293
- package/html/test-status.html +0 -281
- package/html/vercel-cli-setup-guide.html +0 -495
- package/html/vercel-first-time-setup-guide.html +0 -454
- package/html/vercel.json +0 -29
- package/html-static/11.png +0 -0
- package/html-static/404.html +0 -115
- package/html-static/README.html +0 -609
- package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
- package/html-static/about-doc-builder.html +0 -578
- package/html-static/css/notion-style.css +0 -2502
- package/html-static/documentation-index.html +0 -558
- package/html-static/guides/authentication-default-change.html +0 -457
- package/html-static/guides/authentication-guide.html +0 -596
- package/html-static/guides/claude-workflow-guide.html +0 -1161
- package/html-static/guides/configuration-guide.html +0 -559
- package/html-static/guides/documentation-standards.html +0 -781
- package/html-static/guides/html-embedding-guide.html +0 -548
- package/html-static/guides/image-modal-guide.html +0 -602
- package/html-static/guides/phosphor-icons-guide.html +0 -671
- package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -642
- package/html-static/guides/private-directory-authentication.html +0 -628
- package/html-static/guides/public-site-deployment.html +0 -518
- package/html-static/guides/search-engine-verification-guide.html +0 -629
- package/html-static/guides/seo-guide.html +0 -748
- package/html-static/guides/seo-optimization-guide.html +0 -974
- package/html-static/guides/supabase-authentication-complete-guide.html +0 -953
- package/html-static/guides/troubleshooting-guide.html +0 -720
- package/html-static/guides/windows-setup-guide.html +0 -946
- package/html-static/image-modal-test.html +0 -405
- package/html-static/index.html +0 -609
- package/html-static/js/main.js +0 -1754
- package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
- package/html-static/prompts/beautiful-documentation-design.html +0 -871
- package/html-static/prompts/markdown-document-standards.html +0 -509
- package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -617
- package/html-static/robots.txt +0 -5
- package/html-static/sitemap.xml +0 -195
- package/html-static/test-questions/how-does-it-work%3F.html +0 -381
- package/html-static/test-questions/step-1%3A%20getting-started.html +0 -376
- package/html-static/test-questions/what-is-the-purpose.html +0 -380
- package/html-static/vercel-cli-setup-guide.html +0 -582
- package/html-static/vercel-first-time-setup-guide.html +0 -541
- package/manage-users.sql +0 -191
- package/migrate-to-domain-auth.sql +0 -47
- package/package/CACHE-BUSTING-GUIDE.md +0 -82
- package/package/CHANGELOG.md +0 -902
- package/package/README.md +0 -248
- package/package/assets/css/notion-style.css +0 -2211
- package/package/assets/js/auth.js +0 -67
- package/package/assets/js/main.js +0 -1565
- package/package/cli.js +0 -764
- package/package/index.js +0 -38
- package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
- package/package/lib/builder.js +0 -32
- package/package/lib/config.js +0 -278
- package/package/lib/core-builder.js +0 -957
- package/package/lib/deploy.js +0 -497
- package/package/lib/dev-server.js +0 -96
- package/package/package.json +0 -34
- package/package/scripts/npx-runner.js +0 -27
- package/package/scripts/setup.js +0 -56
- package/package/test-cache-bust.sh +0 -43
- package/public-config.js +0 -22
- package/public-html/404.html +0 -115
- package/public-html/README.html +0 -149
- package/public-html/css/notion-style.css +0 -2036
- package/public-html/index.html +0 -149
- package/public-html/js/auth.js +0 -67
- package/public-html/js/main.js +0 -1485
- package/quick-test-commands.md +0 -40
- package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
- package/recordings/mh-ls-22jul.txt +0 -2305
- package/screenshot.png +0 -0
- package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
- package/setup-database-v2.sql +0 -53
- package/setup-database.sql +0 -41
- package/test-auth-config.js +0 -17
- package/test-cache-bust.sh +0 -43
- package/test-docs/README.md +0 -39
- package/test-html/404.html +0 -115
- package/test-html/README.html +0 -172
- package/test-html/auth.js +0 -97
- package/test-html/css/notion-style.css +0 -2036
- package/test-html/index.html +0 -172
- package/test-html/js/auth.js +0 -97
- package/test-html/js/main.js +0 -1485
- package/test-html/login.html +0 -102
- package/test-html/logout.html +0 -18
- package/update-domain.sql +0 -9
- package/user-access-view.sql +0 -49
- package/user-management/README.md +0 -301
- package/user-management/add-users.sh +0 -776
- package/user-management/create-user.js +0 -65
- package/user-management/users.txt +0 -15
- package/view-all-users.sql +0 -40
- package/wru-auth-config.js +0 -17
|
@@ -1,887 +0,0 @@
|
|
|
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="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings.">
|
|
7
|
-
<title>SEO Optimization Guide for @knowcode/doc-builder</title>
|
|
8
|
-
|
|
9
|
-
<meta name="generator" content="@knowcode/doc-builder by Knowcode Ltd">
|
|
10
|
-
<meta name="author" content="Lindsay Smith">
|
|
11
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, SEO, optimization">
|
|
12
|
-
<meta name="robots" content="index, follow">
|
|
13
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html">
|
|
14
|
-
|
|
15
|
-
<!-- Open Graph / Facebook -->
|
|
16
|
-
<meta property="og:type" content="article">
|
|
17
|
-
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html">
|
|
18
|
-
<meta property="og:title" content="SEO Optimization Guide for @knowcode/doc-builder">
|
|
19
|
-
<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.">
|
|
20
|
-
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
21
|
-
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
22
|
-
<meta property="og:locale" content="en_US">
|
|
23
|
-
|
|
24
|
-
<!-- Twitter Card -->
|
|
25
|
-
<meta name="twitter:card" content="summary_large_image">
|
|
26
|
-
<meta name="twitter:site" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:creator" content="@planbbackups">
|
|
28
|
-
<meta name="twitter:title" content="SEO Optimization Guide for @knowcode/doc-builder">
|
|
29
|
-
<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.">
|
|
30
|
-
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
31
|
-
|
|
32
|
-
<!-- Custom Meta Tags -->
|
|
33
|
-
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
34
|
-
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
35
|
-
|
|
36
|
-
<!-- Fonts -->
|
|
37
|
-
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
38
|
-
|
|
39
|
-
<!-- Icons -->
|
|
40
|
-
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
41
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
42
|
-
|
|
43
|
-
<!-- Mermaid -->
|
|
44
|
-
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
45
|
-
|
|
46
|
-
<!-- Styles -->
|
|
47
|
-
<link rel="stylesheet" href="/css/notion-style.css">
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
<!-- Hide content until auth check -->
|
|
53
|
-
<style>
|
|
54
|
-
body {
|
|
55
|
-
visibility: hidden;
|
|
56
|
-
opacity: 0;
|
|
57
|
-
transition: opacity 0.3s ease;
|
|
58
|
-
}
|
|
59
|
-
body.authenticated {
|
|
60
|
-
visibility: visible;
|
|
61
|
-
opacity: 1;
|
|
62
|
-
}
|
|
63
|
-
/* Show login/logout pages immediately */
|
|
64
|
-
body.auth-page {
|
|
65
|
-
visibility: visible;
|
|
66
|
-
opacity: 1;
|
|
67
|
-
}
|
|
68
|
-
/* Style auth button consistently */
|
|
69
|
-
.auth-btn {
|
|
70
|
-
background: none;
|
|
71
|
-
border: none;
|
|
72
|
-
color: var(--text-secondary);
|
|
73
|
-
cursor: pointer;
|
|
74
|
-
padding: 0.5rem;
|
|
75
|
-
border-radius: 0.5rem;
|
|
76
|
-
transition: all 0.2s;
|
|
77
|
-
font-size: 1.1rem;
|
|
78
|
-
}
|
|
79
|
-
.auth-btn:hover {
|
|
80
|
-
background: var(--bg-secondary);
|
|
81
|
-
color: var(--text-primary);
|
|
82
|
-
}
|
|
83
|
-
</style>
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
<!-- Favicon -->
|
|
87
|
-
<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>">
|
|
88
|
-
|
|
89
|
-
<script type="application/ld+json">
|
|
90
|
-
{
|
|
91
|
-
"@context": "https://schema.org",
|
|
92
|
-
"@type": "TechArticle",
|
|
93
|
-
"headline": "SEO Optimization Guide for @knowcode/doc-builder",
|
|
94
|
-
"description": "Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings.",
|
|
95
|
-
"author": {
|
|
96
|
-
"@type": "Person",
|
|
97
|
-
"name": "Lindsay Smith"
|
|
98
|
-
},
|
|
99
|
-
"publisher": {
|
|
100
|
-
"@type": "Organization",
|
|
101
|
-
"name": "Knowcode Ltd",
|
|
102
|
-
"url": "https://knowcode.tech"
|
|
103
|
-
},
|
|
104
|
-
"datePublished": "2025-08-12T21:40:09.393Z",
|
|
105
|
-
"dateModified": "2025-08-12T21:40:09.393Z",
|
|
106
|
-
"mainEntityOfPage": {
|
|
107
|
-
"@type": "WebPage",
|
|
108
|
-
"@id": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
|
|
109
|
-
},
|
|
110
|
-
"breadcrumb": {
|
|
111
|
-
"@type": "BreadcrumbList",
|
|
112
|
-
"itemListElement": [
|
|
113
|
-
{
|
|
114
|
-
"@type": "ListItem",
|
|
115
|
-
"position": 1,
|
|
116
|
-
"name": "@knowcode/doc-builder",
|
|
117
|
-
"item": "https://doc-builder-delta.vercel.app"
|
|
118
|
-
},
|
|
119
|
-
{
|
|
120
|
-
"@type": "ListItem",
|
|
121
|
-
"position": 2,
|
|
122
|
-
"name": "Guides",
|
|
123
|
-
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
124
|
-
},
|
|
125
|
-
{
|
|
126
|
-
"@type": "ListItem",
|
|
127
|
-
"position": 3,
|
|
128
|
-
"name": "Seo Optimization Guide",
|
|
129
|
-
"item": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
|
|
130
|
-
}
|
|
131
|
-
]
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
</script>
|
|
135
|
-
</head>
|
|
136
|
-
<body>
|
|
137
|
-
|
|
138
|
-
<!-- Header -->
|
|
139
|
-
<header class="header">
|
|
140
|
-
<div class="header-content">
|
|
141
|
-
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
142
|
-
|
|
143
|
-
<div class="header-actions">
|
|
144
|
-
<div class="deployment-info">
|
|
145
|
-
<span class="deployment-date" title="Built with doc-builder v1.9.29">Last updated: Aug 12, 2025, 09:40 PM UTC</span>
|
|
146
|
-
</div>
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
150
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
151
|
-
</a>
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
155
|
-
<i class="fas fa-moon"></i>
|
|
156
|
-
</button>
|
|
157
|
-
|
|
158
|
-
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
159
|
-
<i class="fas fa-bars"></i>
|
|
160
|
-
</button>
|
|
161
|
-
</div>
|
|
162
|
-
</div>
|
|
163
|
-
</header>
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
<!-- Breadcrumbs -->
|
|
169
|
-
<nav class="breadcrumbs " id="breadcrumbs" >
|
|
170
|
-
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
171
|
-
</nav>
|
|
172
|
-
|
|
173
|
-
<!-- Main Content -->
|
|
174
|
-
<div class="main-wrapper">
|
|
175
|
-
<!-- Sidebar -->
|
|
176
|
-
<aside class="sidebar">
|
|
177
|
-
<div class="sidebar-header">
|
|
178
|
-
<div class="filter-box">
|
|
179
|
-
<input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
|
|
180
|
-
<i class="fas fa-search filter-icon"></i>
|
|
181
|
-
</div>
|
|
182
|
-
</div>
|
|
183
|
-
<nav class="navigation">
|
|
184
|
-
|
|
185
|
-
<div class="nav-section" data-level="0">
|
|
186
|
-
<a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
|
|
187
|
-
<i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
|
|
188
|
-
</a>
|
|
189
|
-
<div class="nav-content">
|
|
190
|
-
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
|
|
191
|
-
<a href="/about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> About Doc Builder</a>
|
|
192
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Index</a>
|
|
193
|
-
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="ph ph-file-text"></i> Image Modal Test</a>
|
|
194
|
-
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel Cli Setup Guide</a>
|
|
195
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel First Time Setup Guide</a></div></div>
|
|
196
|
-
<div class="nav-section" data-level="1">
|
|
197
|
-
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
198
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
|
|
199
|
-
</a>
|
|
200
|
-
<div class="nav-content" id="nav-guides-1">
|
|
201
|
-
<a href="/guides/authentication-default-change.html" class="nav-item" data-tooltip="Starting from version 1.7.4, @knowcode/doc-builder now defaults to no authentication for all documentation sites."><i class="ph ph-file-text"></i> Authentication Default Change</a>
|
|
202
|
-
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="ph ph-check-circle" style="color: #059669;"></i> Authentication Guide</a>
|
|
203
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Claude Workflow Guide</a>
|
|
204
|
-
<a href="/guides/configuration-guide.html" class="nav-item" data-tooltip="This guide explains how @knowcode/doc-builder handles configuration files and settings."><i class="ph ph-check-circle" style="color: #059669;"></i> Configuration Guide</a>
|
|
205
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Standards</a>
|
|
206
|
-
<a href="/guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="ph ph-check-circle" style="color: #059669;"></i> Html Embedding Guide</a>
|
|
207
|
-
<a href="/guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="ph ph-check-circle" style="color: #059669;"></i> Image Modal Guide</a>
|
|
208
|
-
<a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Phosphor Icons Guide</a>
|
|
209
|
-
<a href="/guides/private-directory-authentication.html" class="nav-item" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication</a>
|
|
210
|
-
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication Troubleshooting</a>
|
|
211
|
-
<a href="/guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="ph ph-check-circle" style="color: #059669;"></i> Public Site Deployment</a>
|
|
212
|
-
<a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="ph ph-check-circle" style="color: #059669;"></i> Search Engine Verification Guide</a>
|
|
213
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Seo Guide</a>
|
|
214
|
-
<a href="/guides/seo-optimization-guide.html" class="nav-item active" data-tooltip="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."><i class="ph ph-check-circle" style="color: #059669;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
|
|
215
|
-
<a href="/guides/supabase-authentication-complete-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes built-in Supabase authentication that provides enterprise-grade security with zero configuration."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Authentication Complete Guide</a>
|
|
216
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Troubleshooting Guide</a>
|
|
217
|
-
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="ph ph-check-circle" style="color: #059669;"></i> Windows Setup Guide</a></div></div>
|
|
218
|
-
<div class="nav-section private-nav" data-level="1">
|
|
219
|
-
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
220
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-lock"></i> Private
|
|
221
|
-
</a>
|
|
222
|
-
<div class="nav-content collapsed" id="nav-private-1">
|
|
223
|
-
<a href="/private/cache-control-anti-pattern.html" class="nav-item" data-tooltip="Cache Control Anti-Pattern: Why Aggressive Cache-Busting is Bad for Documentation Sites."><i class="ph ph-check-circle" style="color: #059669;"></i> Cache Control Anti Pattern</a>
|
|
224
|
-
<a href="/private/next-steps-walkthrough.html" class="nav-item" data-tooltip="Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment."><i class="ph ph-check-circle" style="color: #059669;"></i> Next Steps Walkthrough</a>
|
|
225
|
-
<a href="/private/supabase-auth-implementation-completed.html" class="nav-item" data-tooltip="This document records the successful implementation of Supabase authentication in @knowcode/doc-builder v1.7.5+."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Completed</a>
|
|
226
|
-
<a href="/private/supabase-auth-implementation-plan.html" class="nav-item" data-tooltip="Supabase Auth Implementation Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Plan</a>
|
|
227
|
-
<a href="/private/supabase-auth-integration-plan.html" class="nav-item" data-tooltip="Supabase Authentication Integration Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Integration Plan</a>
|
|
228
|
-
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Setup Guide</a>
|
|
229
|
-
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="ph ph-file-text"></i> Test Private Doc</a>
|
|
230
|
-
<a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="ph ph-check-circle" style="color: #059669;"></i> User Management Tooling</a></div></div>
|
|
231
|
-
<div class="nav-section private-nav" data-level="2">
|
|
232
|
-
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
233
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-rocket-launch"></i> Launch
|
|
234
|
-
</a>
|
|
235
|
-
<div class="nav-content collapsed" id="nav-private-launch-2">
|
|
236
|
-
<a href="/private/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="ph ph-check-circle" style="color: #059669;"></i> Launch Overview</a>
|
|
237
|
-
<a href="/private/launch/auth-cleanup-summary.html" class="nav-item" data-tooltip="All references to the old client-side authentication system have been removed from @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Auth Cleanup Summary</a>
|
|
238
|
-
<a href="/private/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Bubble Plugin Specification</a>
|
|
239
|
-
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Go To Market Strategy</a>
|
|
240
|
-
<a href="/private/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="ph ph-check-circle" style="color: #059669;"></i> Launch Announcements</a>
|
|
241
|
-
<a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel Deployment Auth Setup</a></div></div>
|
|
242
|
-
<div class="nav-section" data-level="1">
|
|
243
|
-
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
244
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
|
|
245
|
-
</a>
|
|
246
|
-
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
247
|
-
<a href="/prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Beautiful Documentation Design</a>
|
|
248
|
-
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Markdown Document Standards</a>
|
|
249
|
-
<a href="/prompts/project-rename-strategy-sasha-publish.html" class="nav-item" data-tooltip="This document outlines the comprehensive strategy for renaming the @knowcode/doc-builder project to "sasha-publish", including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
|
|
250
|
-
<div class="nav-section" data-level="1">
|
|
251
|
-
<a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
|
|
252
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
|
|
253
|
-
</a>
|
|
254
|
-
<div class="nav-content collapsed" id="nav-test-questions-1">
|
|
255
|
-
<a href="/test-questions/how-does-it-work%3F.html" class="nav-item" data-tooltip="This is a test file to verify that question marks work properly in filenames."><i class="ph ph-file-text"></i> How Does It Work?</a>
|
|
256
|
-
<a href="/test-questions/step-1%3A%20getting-started.html" class="nav-item" data-tooltip="Step 1: Getting Started."><i class="ph ph-file-text"></i> Step 1: Getting Started</a>
|
|
257
|
-
<a href="/test-questions/what-is-the-purpose.html" class="nav-item" data-tooltip="Understanding the purpose of our documentation system"><i class="ph ph-file-text"></i> What Is The Purpose?</a></div></div>
|
|
258
|
-
</nav>
|
|
259
|
-
<div class="resize-handle"></div>
|
|
260
|
-
</aside>
|
|
261
|
-
|
|
262
|
-
<!-- Content Area -->
|
|
263
|
-
<main class="content">
|
|
264
|
-
<div class="content-inner">
|
|
265
|
-
<h1>SEO Optimization Guide</h1>
|
|
266
|
-
<h2>Overview</h2>
|
|
267
|
-
<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>
|
|
268
|
-
<h2>Why SEO Matters for Documentation</h2>
|
|
269
|
-
<p>Good SEO helps your documentation:</p>
|
|
270
|
-
<ul>
|
|
271
|
-
<li><strong>Rank higher</strong> in search results (Google, Bing, DuckDuckGo)</li>
|
|
272
|
-
<li><strong>Get more organic traffic</strong> from developers searching for solutions</li>
|
|
273
|
-
<li><strong>Improve click-through rates</strong> with compelling titles and descriptions</li>
|
|
274
|
-
<li><strong>Reach the right audience</strong> with targeted keywords</li>
|
|
275
|
-
<li><strong>Build domain authority</strong> and credibility</li>
|
|
276
|
-
</ul>
|
|
277
|
-
<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>
|
|
278
|
-
<h2>What Our SEO Features Do</h2>
|
|
279
|
-
<h3>1. Automatic Meta Tag Generation</h3>
|
|
280
|
-
<p>Doc-builder automatically generates essential HTML meta tags for every page:</p>
|
|
281
|
-
<pre><code class="language-html"><!-- Page Title - Shows in browser tabs and search results -->
|
|
282
|
-
<title>Your Page Title | Site Name</title>
|
|
283
|
-
|
|
284
|
-
<!-- Meta Description - The snippet shown in search results -->
|
|
285
|
-
<meta name="description" content="Your page description here">
|
|
286
|
-
|
|
287
|
-
<!-- Keywords - Helps search engines understand topic relevance -->
|
|
288
|
-
<meta name="keywords" content="keyword1, keyword2, keyword3">
|
|
289
|
-
|
|
290
|
-
<!-- Author Information -->
|
|
291
|
-
<meta name="author" content="Your Name">
|
|
292
|
-
|
|
293
|
-
<!-- Canonical URL - Prevents duplicate content issues -->
|
|
294
|
-
<link rel="canonical" href="https://yoursite.com/page.html">
|
|
295
|
-
|
|
296
|
-
<!-- Language and Region -->
|
|
297
|
-
<meta property="og:locale" content="en_US">
|
|
298
|
-
</code></pre>
|
|
299
|
-
<h3>2. Open Graph Protocol (Facebook, LinkedIn, Slack)</h3>
|
|
300
|
-
<p>Ensures your documentation looks professional when shared on social media:</p>
|
|
301
|
-
<pre><code class="language-html"><meta property="og:type" content="article">
|
|
302
|
-
<meta property="og:title" content="Page Title">
|
|
303
|
-
<meta property="og:description" content="Page description">
|
|
304
|
-
<meta property="og:url" content="https://yoursite.com/page.html">
|
|
305
|
-
<meta property="og:image" content="https://yoursite.com/og-image.png">
|
|
306
|
-
<meta property="og:site_name" content="Your Site Name">
|
|
307
|
-
</code></pre>
|
|
308
|
-
<p>Learn more: <a href="https://ogp.me/">Open Graph Protocol Official Documentation</a></p>
|
|
309
|
-
<h3>3. Twitter Card Tags</h3>
|
|
310
|
-
<p>Optimizes how your documentation appears on Twitter/X:</p>
|
|
311
|
-
<pre><code class="language-html"><meta name="twitter:card" content="summary_large_image">
|
|
312
|
-
<meta name="twitter:site" content="@yourhandle">
|
|
313
|
-
<meta name="twitter:title" content="Page Title">
|
|
314
|
-
<meta name="twitter:description" content="Page description">
|
|
315
|
-
<meta name="twitter:image" content="https://yoursite.com/twitter-image.png">
|
|
316
|
-
</code></pre>
|
|
317
|
-
<p>Test your cards: <a href="https://cards-dev.twitter.com/validator">Twitter Card Validator</a></p>
|
|
318
|
-
<h3>4. Structured Data (JSON-LD)</h3>
|
|
319
|
-
<p>Helps search engines understand your content structure and display rich snippets:</p>
|
|
320
|
-
<pre><code class="language-json">{
|
|
321
|
-
"@context": "https://schema.org",
|
|
322
|
-
"@type": "TechArticle",
|
|
323
|
-
"headline": "Your Page Title",
|
|
324
|
-
"description": "Your page description",
|
|
325
|
-
"author": {
|
|
326
|
-
"@type": "Person",
|
|
327
|
-
"name": "Author Name"
|
|
328
|
-
},
|
|
329
|
-
"publisher": {
|
|
330
|
-
"@type": "Organization",
|
|
331
|
-
"name": "Your Organization",
|
|
332
|
-
"url": "https://yoursite.com"
|
|
333
|
-
},
|
|
334
|
-
"datePublished": "2025-01-22",
|
|
335
|
-
"dateModified": "2025-01-22",
|
|
336
|
-
"breadcrumb": {
|
|
337
|
-
"@type": "BreadcrumbList",
|
|
338
|
-
"itemListElement": [...]
|
|
339
|
-
}
|
|
340
|
-
}
|
|
341
|
-
</code></pre>
|
|
342
|
-
<p>Validate your structured data: <a href="https://search.google.com/test/rich-results">Google's Rich Results Test</a></p>
|
|
343
|
-
<h3>5. Automatic Sitemap Generation</h3>
|
|
344
|
-
<p>Creates a <code>sitemap.xml</code> file that helps search engines discover all your pages:</p>
|
|
345
|
-
<pre><code class="language-xml"><?xml version="1.0" encoding="UTF-8"?>
|
|
346
|
-
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|
347
|
-
<url>
|
|
348
|
-
<loc>https://yoursite.com/index.html</loc>
|
|
349
|
-
<lastmod>2025-01-22</lastmod>
|
|
350
|
-
<changefreq>weekly</changefreq>
|
|
351
|
-
<priority>1.0</priority>
|
|
352
|
-
</url>
|
|
353
|
-
<!-- More URLs -->
|
|
354
|
-
</urlset>
|
|
355
|
-
</code></pre>
|
|
356
|
-
<p>Submit your sitemap: <a href="https://search.google.com/search-console">Google Search Console</a></p>
|
|
357
|
-
<h3>6. Robots.txt Generation</h3>
|
|
358
|
-
<p>Controls how search engines crawl your site:</p>
|
|
359
|
-
<pre><code>User-agent: *
|
|
360
|
-
Allow: /
|
|
361
|
-
Sitemap: https://yoursite.com/sitemap.xml
|
|
362
|
-
</code></pre>
|
|
363
|
-
<h2>Front Matter Support (v1.5.5+)</h2>
|
|
364
|
-
<p>@knowcode/doc-builder now supports YAML front matter for page-specific SEO customization:</p>
|
|
365
|
-
<pre><code class="language-yaml">---
|
|
366
|
-
title: "Complete Guide to Authentication | @knowcode/doc-builder"
|
|
367
|
-
description: "Learn how to secure your documentation with password protection. Step-by-step guide with code examples and best practices."
|
|
368
|
-
keywords: ["authentication", "security", "password protection", "doc-builder", "documentation"]
|
|
369
|
-
---
|
|
370
|
-
</code></pre>
|
|
371
|
-
<h3>Priority System</h3>
|
|
372
|
-
<p>SEO fields are determined by priority:</p>
|
|
373
|
-
<ol>
|
|
374
|
-
<li><strong>Title</strong>: Front matter → H1 heading → Filename</li>
|
|
375
|
-
<li><strong>Description</strong>: Front matter → Smart extraction → First paragraph</li>
|
|
376
|
-
<li><strong>Keywords</strong>: Front matter + Content extraction + Global keywords</li>
|
|
377
|
-
</ol>
|
|
378
|
-
<h2>Title Optimization</h2>
|
|
379
|
-
<h3>Best Practices (2025 Standards)</h3>
|
|
380
|
-
<ol>
|
|
381
|
-
<li><strong>Length</strong>: Keep titles between 50-60 characters</li>
|
|
382
|
-
<li><strong>Keywords First</strong>: Place primary keywords at the beginning</li>
|
|
383
|
-
<li><strong>Branding</strong>: Use customizable title templates</li>
|
|
384
|
-
<li><strong>Unique</strong>: Each page should have a unique title</li>
|
|
385
|
-
</ol>
|
|
386
|
-
<h3>Title Templates</h3>
|
|
387
|
-
<p>Configure title format in <code>doc-builder.config.js</code>:</p>
|
|
388
|
-
<pre><code class="language-javascript">seo: {
|
|
389
|
-
titleTemplate: '{pageTitle} | {siteName}', // Default
|
|
390
|
-
// or
|
|
391
|
-
titleTemplate: '{pageTitle} - {siteName} Docs',
|
|
392
|
-
// or
|
|
393
|
-
titleTemplate: '{siteName}: {pageTitle}'
|
|
394
|
-
}
|
|
395
|
-
</code></pre>
|
|
396
|
-
<h3>Examples</h3>
|
|
397
|
-
<p>Good titles:</p>
|
|
398
|
-
<ul>
|
|
399
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> "Authentication Guide | Doc Builder" (38 chars)</li>
|
|
400
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> "SEO Best Practices for Documentation | MyDocs" (45 chars)</li>
|
|
401
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> "Quick Start: Deploy to Vercel | Doc Builder" (43 chars)</li>
|
|
402
|
-
</ul>
|
|
403
|
-
<p>Bad titles:</p>
|
|
404
|
-
<ul>
|
|
405
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> "Guide" (5 chars - too short)</li>
|
|
406
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> "The Complete Comprehensive Guide to Setting Up Authentication and Security for Your Documentation Website | Doc Builder" (118 chars - too long)</li>
|
|
407
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> "Page Title | Site Name | Category | Subcategory" (keyword stuffing)</li>
|
|
408
|
-
</ul>
|
|
409
|
-
<h2>Meta Descriptions</h2>
|
|
410
|
-
<h3>Best Practices</h3>
|
|
411
|
-
<ol>
|
|
412
|
-
<li><strong>Length</strong>: 140-160 characters (ideal for 2025)</li>
|
|
413
|
-
<li><strong>Action-Oriented</strong>: Include call-to-action</li>
|
|
414
|
-
<li><strong>Keywords</strong>: Natural keyword inclusion</li>
|
|
415
|
-
<li><strong>Unique</strong>: Avoid duplicate descriptions</li>
|
|
416
|
-
<li><strong>Value Proposition</strong>: Explain what users will learn</li>
|
|
417
|
-
</ol>
|
|
418
|
-
<h3>Smart Description Extraction</h3>
|
|
419
|
-
<p>Doc-builder uses intelligent extraction:</p>
|
|
420
|
-
<ol>
|
|
421
|
-
<li>Checks for front matter description</li>
|
|
422
|
-
<li>Looks for intro paragraph after H1</li>
|
|
423
|
-
<li>Falls back to first paragraph</li>
|
|
424
|
-
<li>Ensures optimal length with word boundaries</li>
|
|
425
|
-
</ol>
|
|
426
|
-
<h3>Examples</h3>
|
|
427
|
-
<p>Good descriptions:</p>
|
|
428
|
-
<ul>
|
|
429
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> "Learn how to implement authentication in your documentation site. Step-by-step guide with code examples and security best practices." (139 chars)</li>
|
|
430
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> "Optimize your documentation for search engines with our comprehensive SEO guide. Covers titles, descriptions, and keyword strategies." (143 chars)</li>
|
|
431
|
-
</ul>
|
|
432
|
-
<p>Bad descriptions:</p>
|
|
433
|
-
<ul>
|
|
434
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> "This page is about authentication." (35 chars - too short)</li>
|
|
435
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> "Authentication authentication authentication..." (keyword stuffing)</li>
|
|
436
|
-
</ul>
|
|
437
|
-
<h2>Keywords Strategy</h2>
|
|
438
|
-
<h3>Modern Keyword Approach (2025)</h3>
|
|
439
|
-
<ol>
|
|
440
|
-
<li><strong>Topic Clusters</strong>: Focus on related topics, not single keywords</li>
|
|
441
|
-
<li><strong>User Intent</strong>: Answer specific questions</li>
|
|
442
|
-
<li><strong>Long-tail Keywords</strong>: Target conversational phrases</li>
|
|
443
|
-
<li><strong>Natural Language</strong>: Write for humans, not algorithms</li>
|
|
444
|
-
</ol>
|
|
445
|
-
<h3>Configuration</h3>
|
|
446
|
-
<pre><code class="language-javascript">seo: {
|
|
447
|
-
autoKeywords: true, // Extract from content
|
|
448
|
-
keywordLimit: 7, // Max per page
|
|
449
|
-
keywords: [ // Global keywords
|
|
450
|
-
"documentation",
|
|
451
|
-
"static site",
|
|
452
|
-
"vercel"
|
|
453
|
-
]
|
|
454
|
-
}
|
|
455
|
-
</code></pre>
|
|
456
|
-
<h3>Front Matter Keywords</h3>
|
|
457
|
-
<pre><code class="language-yaml">---
|
|
458
|
-
keywords:
|
|
459
|
-
- "authentication guide"
|
|
460
|
-
- "secure documentation"
|
|
461
|
-
- "password protection"
|
|
462
|
-
- "doc-builder security"
|
|
463
|
-
---
|
|
464
|
-
</code></pre>
|
|
465
|
-
<h2>Using the SEO Check Command (v1.5.8+)</h2>
|
|
466
|
-
<p>The <code>seo-check</code> command analyzes your <strong>generated HTML files</strong> to ensure they're properly optimized:</p>
|
|
467
|
-
<pre><code class="language-bash"># First, build your documentation
|
|
468
|
-
doc-builder build
|
|
469
|
-
|
|
470
|
-
# Then analyze the generated HTML
|
|
471
|
-
doc-builder seo-check
|
|
472
|
-
|
|
473
|
-
# Check specific HTML file
|
|
474
|
-
doc-builder seo-check html/guide.html
|
|
475
|
-
</code></pre>
|
|
476
|
-
<h3>What It Analyzes in HTML</h3>
|
|
477
|
-
<p>The command inspects the actual HTML output that search engines see:</p>
|
|
478
|
-
<ul>
|
|
479
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Title tags</strong> - Presence and optimal length (50-60 chars)</li>
|
|
480
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Meta descriptions</strong> - Quality and character count (140-160)</li>
|
|
481
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Keywords meta tag</strong> - Presence of relevant keywords</li>
|
|
482
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Canonical URLs</strong> - Prevents duplicate content penalties</li>
|
|
483
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>H1 tags</strong> - Ensures proper heading structure</li>
|
|
484
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Open Graph tags</strong> - Social media optimization</li>
|
|
485
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Twitter Card tags</strong> - Twitter/X optimization</li>
|
|
486
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Structured data</strong> - JSON-LD implementation</li>
|
|
487
|
-
</ul>
|
|
488
|
-
<h3>Example Output</h3>
|
|
489
|
-
<pre><code>🔍 Analyzing SEO in generated HTML files...
|
|
490
|
-
|
|
491
|
-
📊 SEO Analysis Complete
|
|
492
|
-
|
|
493
|
-
Analyzed 14 files
|
|
494
|
-
|
|
495
|
-
❌ Found 2 issues:
|
|
496
|
-
|
|
497
|
-
guides/api.html:
|
|
498
|
-
Title too long (75 chars, max 60)
|
|
499
|
-
Suggestion: API Reference Documentation for Doc Build...
|
|
500
|
-
|
|
501
|
-
setup.html:
|
|
502
|
-
Missing meta description
|
|
503
|
-
|
|
504
|
-
💡 8 suggestions:
|
|
505
|
-
|
|
506
|
-
index.html: Description too short (95 chars, ideal 140-160)
|
|
507
|
-
guides/auth.html: No keywords meta tag found
|
|
508
|
-
api/endpoints.html: Missing canonical URL
|
|
509
|
-
tutorials/intro.html: H1 differs from page title
|
|
510
|
-
guides/deploy.html: Missing Open Graph tags
|
|
511
|
-
</code></pre>
|
|
512
|
-
<h2>Advanced Configuration</h2>
|
|
513
|
-
<h3>Per-Page Customization</h3>
|
|
514
|
-
<p>Each markdown file can have custom SEO:</p>
|
|
515
|
-
<pre><code class="language-markdown">---
|
|
516
|
-
title: "Custom Page Title for SEO"
|
|
517
|
-
description: "Override the auto-generated description with this custom one that's perfectly optimized."
|
|
518
|
-
keywords: ["specific", "page", "keywords"]
|
|
519
|
-
---
|
|
520
|
-
|
|
521
|
-
# Different H1 for Display
|
|
522
|
-
|
|
523
|
-
Your content here...
|
|
524
|
-
</code></pre>
|
|
525
|
-
<h3>Global SEO Settings</h3>
|
|
526
|
-
<p>Configure in <code>doc-builder.config.js</code>:</p>
|
|
527
|
-
<pre><code class="language-javascript">module.exports = {
|
|
528
|
-
siteName: 'My Documentation',
|
|
529
|
-
siteDescription: 'Default description for all pages',
|
|
530
|
-
|
|
531
|
-
seo: {
|
|
532
|
-
enabled: true,
|
|
533
|
-
siteUrl: 'https://docs.example.com',
|
|
534
|
-
author: 'Your Name',
|
|
535
|
-
twitterHandle: '@yourhandle',
|
|
536
|
-
language: 'en-US',
|
|
537
|
-
|
|
538
|
-
// Title customization
|
|
539
|
-
titleTemplate: '{pageTitle} | {siteName}',
|
|
540
|
-
|
|
541
|
-
// Description settings
|
|
542
|
-
descriptionFallback: 'smart', // or 'first-paragraph'
|
|
543
|
-
|
|
544
|
-
// Keywords
|
|
545
|
-
keywords: ['documentation', 'guides'],
|
|
546
|
-
autoKeywords: true,
|
|
547
|
-
keywordLimit: 7,
|
|
548
|
-
|
|
549
|
-
// Organization
|
|
550
|
-
organization: {
|
|
551
|
-
name: 'Your Company',
|
|
552
|
-
url: 'https://example.com',
|
|
553
|
-
logo: 'https://example.com/logo.png'
|
|
554
|
-
},
|
|
555
|
-
|
|
556
|
-
// Social
|
|
557
|
-
ogImage: '/og-default.png',
|
|
558
|
-
|
|
559
|
-
// Technical
|
|
560
|
-
generateSitemap: true,
|
|
561
|
-
generateRobotsTxt: true,
|
|
562
|
-
customMetaTags: []
|
|
563
|
-
}
|
|
564
|
-
};
|
|
565
|
-
</code></pre>
|
|
566
|
-
<h2>Common SEO Mistakes to Avoid</h2>
|
|
567
|
-
<h3>1. Duplicate Content</h3>
|
|
568
|
-
<ul>
|
|
569
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Same description on multiple pages</li>
|
|
570
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Unique descriptions for each page</li>
|
|
571
|
-
</ul>
|
|
572
|
-
<h3>2. Keyword Stuffing</h3>
|
|
573
|
-
<ul>
|
|
574
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> "Guide guide documentation guide tutorial guide"</li>
|
|
575
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Natural keyword usage in context</li>
|
|
576
|
-
</ul>
|
|
577
|
-
<h3>3. Ignoring Mobile</h3>
|
|
578
|
-
<ul>
|
|
579
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Long titles that get cut off on mobile</li>
|
|
580
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Test how titles appear on different devices</li>
|
|
581
|
-
</ul>
|
|
582
|
-
<h3>4. Missing Descriptions</h3>
|
|
583
|
-
<ul>
|
|
584
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Leaving description blank</li>
|
|
585
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Always provide meaningful descriptions</li>
|
|
586
|
-
</ul>
|
|
587
|
-
<h3>5. Generic Titles</h3>
|
|
588
|
-
<ul>
|
|
589
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> "Documentation", "Guide", "Page 1"</li>
|
|
590
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Specific, descriptive titles</li>
|
|
591
|
-
</ul>
|
|
592
|
-
<h2>SEO Checklist</h2>
|
|
593
|
-
<p>Before publishing, ensure:</p>
|
|
594
|
-
<ul>
|
|
595
|
-
<li><input disabled="" type="checkbox"> All pages have unique titles (50-60 chars)</li>
|
|
596
|
-
<li><input disabled="" type="checkbox"> All pages have meta descriptions (140-160 chars)</li>
|
|
597
|
-
<li><input disabled="" type="checkbox"> Important pages have front matter SEO</li>
|
|
598
|
-
<li><input disabled="" type="checkbox"> Run <code>doc-builder seo-check</code> and fix issues</li>
|
|
599
|
-
<li><input disabled="" type="checkbox"> Set <code>seo.siteUrl</code> in config for proper URLs</li>
|
|
600
|
-
<li><input disabled="" type="checkbox"> Verify Google site ownership with <code>google-verify</code></li>
|
|
601
|
-
<li><input disabled="" type="checkbox"> Submit sitemap.xml to Google Search Console</li>
|
|
602
|
-
<li><input disabled="" type="checkbox"> Test mobile appearance</li>
|
|
603
|
-
</ul>
|
|
604
|
-
<h2>Best Practices for 2025</h2>
|
|
605
|
-
<h3>AI and Semantic Search</h3>
|
|
606
|
-
<ul>
|
|
607
|
-
<li>Write for topic clusters, not just keywords</li>
|
|
608
|
-
<li>Focus on user intent and questions</li>
|
|
609
|
-
<li>Use natural, conversational language</li>
|
|
610
|
-
<li>Structure content with clear hierarchies</li>
|
|
611
|
-
</ul>
|
|
612
|
-
<h3>Technical Excellence</h3>
|
|
613
|
-
<ul>
|
|
614
|
-
<li>Ensure fast page load times</li>
|
|
615
|
-
<li>Use structured data (automatic with doc-builder)</li>
|
|
616
|
-
<li>Implement proper heading hierarchy</li>
|
|
617
|
-
<li>Include alt text for images</li>
|
|
618
|
-
</ul>
|
|
619
|
-
<h3>Content Quality</h3>
|
|
620
|
-
<ul>
|
|
621
|
-
<li>Write comprehensive, valuable content</li>
|
|
622
|
-
<li>Update regularly to maintain freshness</li>
|
|
623
|
-
<li>Include examples and practical applications</li>
|
|
624
|
-
<li>Link to related documentation</li>
|
|
625
|
-
</ul>
|
|
626
|
-
<h2>Monitoring and Improvement</h2>
|
|
627
|
-
<h3>Track Performance</h3>
|
|
628
|
-
<ol>
|
|
629
|
-
<li>Set up Google Search Console</li>
|
|
630
|
-
<li>Monitor search impressions and clicks</li>
|
|
631
|
-
<li>Track ranking positions</li>
|
|
632
|
-
<li>Analyze user queries</li>
|
|
633
|
-
</ol>
|
|
634
|
-
<h3>Continuous Optimization</h3>
|
|
635
|
-
<ol>
|
|
636
|
-
<li>Update titles based on performance</li>
|
|
637
|
-
<li>A/B test different descriptions</li>
|
|
638
|
-
<li>Expand content for high-value pages</li>
|
|
639
|
-
<li>Build internal links between related docs</li>
|
|
640
|
-
</ol>
|
|
641
|
-
<h2>External SEO Tools and Resources</h2>
|
|
642
|
-
<h3>Essential SEO Tools</h3>
|
|
643
|
-
<h4>1. <strong>Google Search Console</strong> - <a href="https://search.google.com/search-console">search.google.com/search-console</a></h4>
|
|
644
|
-
<ul>
|
|
645
|
-
<li>Monitor your documentation's search performance</li>
|
|
646
|
-
<li>Submit sitemaps for faster indexing</li>
|
|
647
|
-
<li>Find crawl errors and indexing issues</li>
|
|
648
|
-
<li>See which queries bring users to your docs</li>
|
|
649
|
-
<li><strong>Free tool from Google</strong></li>
|
|
650
|
-
</ul>
|
|
651
|
-
<h4>2. <strong>Google PageSpeed Insights</strong> - <a href="https://pagespeed.web.dev">pagespeed.web.dev</a></h4>
|
|
652
|
-
<ul>
|
|
653
|
-
<li>Test page load performance</li>
|
|
654
|
-
<li>Get specific optimization suggestions</li>
|
|
655
|
-
<li>Check Core Web Vitals scores</li>
|
|
656
|
-
<li>Mobile and desktop analysis</li>
|
|
657
|
-
<li><strong>Free tool</strong></li>
|
|
658
|
-
</ul>
|
|
659
|
-
<h4>3. <strong>Ahrefs Webmaster Tools</strong> - <a href="https://ahrefs.com/webmaster-tools">ahrefs.com/webmaster-tools</a></h4>
|
|
660
|
-
<ul>
|
|
661
|
-
<li>Free SEO health monitoring</li>
|
|
662
|
-
<li>Backlink analysis</li>
|
|
663
|
-
<li>Keyword rankings</li>
|
|
664
|
-
<li>Site audit features</li>
|
|
665
|
-
<li><strong>Free version available</strong></li>
|
|
666
|
-
</ul>
|
|
667
|
-
<h4>4. <strong>Schema Markup Validator</strong> - <a href="https://validator.schema.org">validator.schema.org</a></h4>
|
|
668
|
-
<ul>
|
|
669
|
-
<li>Validate your structured data</li>
|
|
670
|
-
<li>Test JSON-LD implementation</li>
|
|
671
|
-
<li>Find schema errors</li>
|
|
672
|
-
<li><strong>Free tool</strong></li>
|
|
673
|
-
</ul>
|
|
674
|
-
<h4>5. <strong>Open Graph Debugger</strong> - <a href="https://www.opengraph.xyz">opengraph.xyz</a></h4>
|
|
675
|
-
<ul>
|
|
676
|
-
<li>Preview how your docs appear on social media</li>
|
|
677
|
-
<li>Debug Open Graph tags</li>
|
|
678
|
-
<li>Test different URLs</li>
|
|
679
|
-
<li><strong>Free tool</strong></li>
|
|
680
|
-
</ul>
|
|
681
|
-
<h3>SEO Learning Resources</h3>
|
|
682
|
-
<h4>Beginner Resources</h4>
|
|
683
|
-
<ol>
|
|
684
|
-
<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>
|
|
685
|
-
<ul>
|
|
686
|
-
<li>Official guide from Google</li>
|
|
687
|
-
<li>Covers all SEO basics</li>
|
|
688
|
-
<li>Best practices straight from the source</li>
|
|
689
|
-
</ul>
|
|
690
|
-
</li>
|
|
691
|
-
<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>
|
|
692
|
-
<ul>
|
|
693
|
-
<li>Comprehensive 7-chapter guide</li>
|
|
694
|
-
<li>Visual explanations</li>
|
|
695
|
-
<li>Industry-standard resource</li>
|
|
696
|
-
</ul>
|
|
697
|
-
</li>
|
|
698
|
-
</ol>
|
|
699
|
-
<h4>Advanced Resources</h4>
|
|
700
|
-
<ol start="3">
|
|
701
|
-
<li><p><strong>Ahrefs SEO Guide</strong> - <a href="https://ahrefs.com/seo">ahrefs.com/seo</a></p>
|
|
702
|
-
<ul>
|
|
703
|
-
<li>Data-driven strategies</li>
|
|
704
|
-
<li>Advanced techniques</li>
|
|
705
|
-
<li>Case studies and examples</li>
|
|
706
|
-
</ul>
|
|
707
|
-
</li>
|
|
708
|
-
<li><p><strong>Search Engine Journal</strong> - <a href="https://searchenginejournal.com">searchenginejournal.com</a></p>
|
|
709
|
-
<ul>
|
|
710
|
-
<li>Latest SEO news and updates</li>
|
|
711
|
-
<li>Algorithm change analysis</li>
|
|
712
|
-
<li>Expert insights</li>
|
|
713
|
-
</ul>
|
|
714
|
-
</li>
|
|
715
|
-
<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>
|
|
716
|
-
<ul>
|
|
717
|
-
<li>Google's technical requirements</li>
|
|
718
|
-
<li>Crawling and indexing details</li>
|
|
719
|
-
<li>Advanced implementation</li>
|
|
720
|
-
</ul>
|
|
721
|
-
</li>
|
|
722
|
-
</ol>
|
|
723
|
-
<h3>Keyword Research Tools</h3>
|
|
724
|
-
<ol>
|
|
725
|
-
<li><p><strong>Google Keyword Planner</strong> - <a href="https://ads.google.com/keywordplanner">ads.google.com/keywordplanner</a></p>
|
|
726
|
-
<ul>
|
|
727
|
-
<li>Free with Google Ads account</li>
|
|
728
|
-
<li>Search volume data</li>
|
|
729
|
-
<li>Keyword suggestions</li>
|
|
730
|
-
</ul>
|
|
731
|
-
</li>
|
|
732
|
-
<li><p><strong>Ubersuggest</strong> - <a href="https://neilpatel.com/ubersuggest">neilpatel.com/ubersuggest</a></p>
|
|
733
|
-
<ul>
|
|
734
|
-
<li>Free keyword research</li>
|
|
735
|
-
<li>Content ideas</li>
|
|
736
|
-
<li>Competitor analysis</li>
|
|
737
|
-
</ul>
|
|
738
|
-
</li>
|
|
739
|
-
<li><p><strong>Answer The Public</strong> - <a href="https://answerthepublic.com">answerthepublic.com</a></p>
|
|
740
|
-
<ul>
|
|
741
|
-
<li>Find questions people ask</li>
|
|
742
|
-
<li>Visual keyword research</li>
|
|
743
|
-
<li>Great for documentation topics</li>
|
|
744
|
-
</ul>
|
|
745
|
-
</li>
|
|
746
|
-
<li><p><strong>Google Trends</strong> - <a href="https://trends.google.com">trends.google.com</a></p>
|
|
747
|
-
<ul>
|
|
748
|
-
<li>Track keyword popularity over time</li>
|
|
749
|
-
<li>Compare search terms</li>
|
|
750
|
-
<li>Find rising topics</li>
|
|
751
|
-
</ul>
|
|
752
|
-
</li>
|
|
753
|
-
</ol>
|
|
754
|
-
<h3>Performance Testing</h3>
|
|
755
|
-
<ol>
|
|
756
|
-
<li><p><strong>GTmetrix</strong> - <a href="https://gtmetrix.com">gtmetrix.com</a></p>
|
|
757
|
-
<ul>
|
|
758
|
-
<li>Detailed performance reports</li>
|
|
759
|
-
<li>Waterfall charts</li>
|
|
760
|
-
<li>Historical tracking</li>
|
|
761
|
-
</ul>
|
|
762
|
-
</li>
|
|
763
|
-
<li><p><strong>WebPageTest</strong> - <a href="https://webpagetest.org">webpagetest.org</a></p>
|
|
764
|
-
<ul>
|
|
765
|
-
<li>Advanced performance testing</li>
|
|
766
|
-
<li>Multiple location testing</li>
|
|
767
|
-
<li>Video capture of page load</li>
|
|
768
|
-
</ul>
|
|
769
|
-
</li>
|
|
770
|
-
<li><p><strong>Lighthouse</strong> (Built into Chrome DevTools)</p>
|
|
771
|
-
<ul>
|
|
772
|
-
<li>Performance, SEO, and accessibility audits</li>
|
|
773
|
-
<li>Actionable recommendations</li>
|
|
774
|
-
<li>CLI version available</li>
|
|
775
|
-
</ul>
|
|
776
|
-
</li>
|
|
777
|
-
</ol>
|
|
778
|
-
<h3>Documentation-Specific SEO Tips</h3>
|
|
779
|
-
<p>According to <a href="https://developers.google.com/style/seo">Google's Documentation Best Practices</a>:</p>
|
|
780
|
-
<ol>
|
|
781
|
-
<li><strong>Use descriptive URLs</strong> - <code>/guides/authentication</code> not <code>/page1</code></li>
|
|
782
|
-
<li><strong>Create comprehensive content</strong> - Answer the full question</li>
|
|
783
|
-
<li><strong>Use code examples</strong> - Show, don't just tell</li>
|
|
784
|
-
<li><strong>Keep content fresh</strong> - Update regularly</li>
|
|
785
|
-
<li><strong>Internal linking</strong> - Connect related topics</li>
|
|
786
|
-
</ol>
|
|
787
|
-
<h2>Quick Reference</h2>
|
|
788
|
-
<h3>Front Matter Template</h3>
|
|
789
|
-
<pre><code class="language-yaml">---
|
|
790
|
-
title: "Your SEO Optimized Title Here | Brand"
|
|
791
|
-
description: "A compelling 140-160 character description that includes keywords and encourages clicks from search results."
|
|
792
|
-
keywords: ["primary keyword", "secondary keyword", "long-tail phrase"]
|
|
793
|
-
author: "Your Name"
|
|
794
|
-
date: "2025-01-22"
|
|
795
|
-
---
|
|
796
|
-
</code></pre>
|
|
797
|
-
<h3>CLI Commands</h3>
|
|
798
|
-
<pre><code class="language-bash"># Build your documentation
|
|
799
|
-
doc-builder build
|
|
800
|
-
|
|
801
|
-
# Check SEO of generated HTML
|
|
802
|
-
doc-builder seo-check
|
|
803
|
-
|
|
804
|
-
# Add Google verification
|
|
805
|
-
doc-builder google-verify YOUR_CODE
|
|
806
|
-
|
|
807
|
-
# Deploy with SEO optimization
|
|
808
|
-
doc-builder deploy
|
|
809
|
-
</code></pre>
|
|
810
|
-
<h3>SEO Checklist</h3>
|
|
811
|
-
<p>Before publishing:</p>
|
|
812
|
-
<ul>
|
|
813
|
-
<li><input disabled="" type="checkbox"> Run <code>doc-builder build</code> to generate HTML</li>
|
|
814
|
-
<li><input disabled="" type="checkbox"> Run <code>doc-builder seo-check</code> to find issues</li>
|
|
815
|
-
<li><input disabled="" type="checkbox"> Fix any critical SEO problems</li>
|
|
816
|
-
<li><input disabled="" type="checkbox"> Add front matter to important pages</li>
|
|
817
|
-
<li><input disabled="" type="checkbox"> Set production URL in config</li>
|
|
818
|
-
<li><input disabled="" type="checkbox"> Generate and submit sitemap</li>
|
|
819
|
-
<li><input disabled="" type="checkbox"> Set up Google Search Console</li>
|
|
820
|
-
<li><input disabled="" type="checkbox"> Add Google Analytics (optional)</li>
|
|
821
|
-
<li><input disabled="" type="checkbox"> Test social media previews</li>
|
|
822
|
-
<li><input disabled="" type="checkbox"> Check page load speed</li>
|
|
823
|
-
</ul>
|
|
824
|
-
<h2>Monitoring Success</h2>
|
|
825
|
-
<h3>Key Metrics to Track</h3>
|
|
826
|
-
<ol>
|
|
827
|
-
<li><strong>Organic Traffic</strong> - Visitors from search engines</li>
|
|
828
|
-
<li><strong>Search Impressions</strong> - How often you appear in results</li>
|
|
829
|
-
<li><strong>Click-Through Rate (CTR)</strong> - Percentage who click</li>
|
|
830
|
-
<li><strong>Average Position</strong> - Where you rank for keywords</li>
|
|
831
|
-
<li><strong>Page Load Time</strong> - Speed affects rankings</li>
|
|
832
|
-
</ol>
|
|
833
|
-
<h3>Tools for Monitoring</h3>
|
|
834
|
-
<ul>
|
|
835
|
-
<li><strong>Google Analytics 4</strong> - <a href="https://analytics.google.com">analytics.google.com</a></li>
|
|
836
|
-
<li><strong>Google Search Console</strong> - Track search performance</li>
|
|
837
|
-
<li><strong>Ahrefs/SEMrush</strong> - Competitive analysis</li>
|
|
838
|
-
<li><strong>Custom dashboards</strong> - Combine multiple data sources</li>
|
|
839
|
-
</ul>
|
|
840
|
-
<h2>Next Steps</h2>
|
|
841
|
-
<ol>
|
|
842
|
-
<li><p><strong>Immediate Actions</strong>:</p>
|
|
843
|
-
<ul>
|
|
844
|
-
<li>Add front matter to your top 10 pages</li>
|
|
845
|
-
<li>Run <code>seo-check</code> and fix critical issues</li>
|
|
846
|
-
<li>Set up Google Search Console</li>
|
|
847
|
-
</ul>
|
|
848
|
-
</li>
|
|
849
|
-
<li><p><strong>This Week</strong>:</p>
|
|
850
|
-
<ul>
|
|
851
|
-
<li>Optimize all page titles and descriptions</li>
|
|
852
|
-
<li>Submit sitemap to search engines</li>
|
|
853
|
-
<li>Test and fix page load speed</li>
|
|
854
|
-
</ul>
|
|
855
|
-
</li>
|
|
856
|
-
<li><p><strong>Ongoing</strong>:</p>
|
|
857
|
-
<ul>
|
|
858
|
-
<li>Monitor search performance weekly</li>
|
|
859
|
-
<li>Update content based on user queries</li>
|
|
860
|
-
<li>Build internal links between related docs</li>
|
|
861
|
-
<li>Keep content fresh and accurate</li>
|
|
862
|
-
</ul>
|
|
863
|
-
</li>
|
|
864
|
-
</ol>
|
|
865
|
-
<hr>
|
|
866
|
-
<p>For more help, see the <a href="./search-engine-verification-guide.md">Search Engine Verification Guide</a> or join the <a href="https://github.com/knowcode/doc-builder/discussions">doc-builder community</a>.</p>
|
|
867
|
-
|
|
868
|
-
</div>
|
|
869
|
-
</main>
|
|
870
|
-
</div>
|
|
871
|
-
|
|
872
|
-
<!-- Scripts -->
|
|
873
|
-
<script>
|
|
874
|
-
// Pass configuration to frontend
|
|
875
|
-
window.docBuilderConfig = {
|
|
876
|
-
features: {
|
|
877
|
-
showPdfDownload: true,
|
|
878
|
-
menuDefaultOpen: false,
|
|
879
|
-
mermaidEnhanced: true
|
|
880
|
-
}
|
|
881
|
-
};
|
|
882
|
-
</script>
|
|
883
|
-
<script src="/js/main.js"></script>
|
|
884
|
-
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
885
|
-
<script src="/js/auth.js"></script>
|
|
886
|
-
</body>
|
|
887
|
-
</html>
|