@knowcode/doc-builder 1.9.1 → 1.9.3
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 +29 -0
- package/CLAUDE.md +35 -0
- package/README.md +1 -0
- package/assets/css/notion-style.css +2 -2
- package/html/README.html +151 -33
- package/html/auth.js +4 -3
- package/html/css/notion-style.css +394 -13
- package/html/documentation-index.html +134 -10
- package/html/guides/authentication-default-change.html +132 -7
- package/html/guides/authentication-guide.html +143 -19
- package/html/guides/claude-workflow-guide.html +139 -22
- package/html/guides/documentation-standards.html +135 -11
- package/html/guides/html-embedding-guide.html +451 -0
- package/html/guides/image-modal-guide.html +134 -10
- package/html/guides/phosphor-icons-guide.html +152 -27
- package/html/guides/private-directory-authentication-troubleshooting.html +545 -0
- package/html/guides/private-directory-authentication.html +132 -7
- package/html/guides/public-site-deployment.html +132 -7
- package/html/guides/search-engine-verification-guide.html +132 -7
- package/html/guides/seo-guide.html +132 -7
- package/html/guides/seo-optimization-guide.html +161 -38
- package/html/guides/troubleshooting-guide.html +143 -19
- package/html/guides/windows-setup-guide.html +163 -38
- package/html/image-modal-test.html +127 -8
- package/html/index.html +151 -33
- package/html/js/auth.js +119 -39
- package/html/js/main.js +259 -25
- package/html/private/cache-control-anti-pattern.html +137 -12
- package/html/private/launch/README.html +146 -15
- package/html/private/launch/auth-cleanup-summary.html +155 -24
- package/html/private/launch/bubble-plugin-specification.html +138 -7
- package/html/private/launch/go-to-market-strategy.html +140 -9
- package/html/private/launch/launch-announcements.html +154 -24
- package/html/private/launch/vercel-deployment-auth-setup.html +140 -9
- package/html/private/next-steps-walkthrough.html +139 -14
- package/html/private/supabase-auth-implementation-completed.html +145 -21
- package/html/private/supabase-auth-implementation-plan.html +138 -14
- package/html/private/supabase-auth-integration-plan.html +144 -21
- package/html/private/supabase-auth-setup-guide.html +141 -16
- package/html/private/test-private-doc.html +132 -7
- package/html/private/user-management-tooling.html +132 -7
- package/html/prompts/markdown-document-standards.html +136 -12
- package/html/sitemap.xml +70 -46
- package/html/vercel-cli-setup-guide.html +130 -11
- package/html/vercel-first-time-setup-guide.html +127 -8
- package/lib/config.js +2 -0
- package/lib/emoji-mapper.js +2 -0
- package/lib/supabase-auth.js +4 -3
- package/package.json +1 -1
|
@@ -3,14 +3,41 @@
|
|
|
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>SEO Guide for @knowcode/doc-builder
|
|
6
|
+
<meta name="description" content="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and look...">
|
|
7
|
+
<title>SEO Guide for @knowcode/doc-builder | @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, your">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/seo-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-guide.html">
|
|
17
|
+
<meta property="og:title" content="SEO Guide for @knowcode/doc-builder | @knowcode/doc-builder">
|
|
18
|
+
<meta property="og:description" content="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and look...">
|
|
19
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
+
<meta property="og:site_name" content="@knowcode/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 Guide for @knowcode/doc-builder | @knowcode/doc-builder">
|
|
28
|
+
<meta name="twitter:description" content="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and look...">
|
|
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
|
+
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
8
34
|
|
|
9
35
|
<!-- Fonts -->
|
|
10
36
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
11
37
|
|
|
12
38
|
<!-- Icons -->
|
|
13
39
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
40
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
14
41
|
|
|
15
42
|
<!-- Mermaid -->
|
|
16
43
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -18,8 +45,90 @@
|
|
|
18
45
|
<!-- Styles -->
|
|
19
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
47
|
|
|
48
|
+
|
|
49
|
+
<!-- Hide content until auth check -->
|
|
50
|
+
<style>
|
|
51
|
+
body {
|
|
52
|
+
visibility: hidden;
|
|
53
|
+
opacity: 0;
|
|
54
|
+
transition: opacity 0.3s ease;
|
|
55
|
+
}
|
|
56
|
+
body.authenticated {
|
|
57
|
+
visibility: visible;
|
|
58
|
+
opacity: 1;
|
|
59
|
+
}
|
|
60
|
+
/* Show login/logout pages immediately */
|
|
61
|
+
body.auth-page {
|
|
62
|
+
visibility: visible;
|
|
63
|
+
opacity: 1;
|
|
64
|
+
}
|
|
65
|
+
/* Style auth button consistently */
|
|
66
|
+
.auth-btn {
|
|
67
|
+
background: none;
|
|
68
|
+
border: none;
|
|
69
|
+
color: var(--text-secondary);
|
|
70
|
+
cursor: pointer;
|
|
71
|
+
padding: 0.5rem;
|
|
72
|
+
border-radius: 0.5rem;
|
|
73
|
+
transition: all 0.2s;
|
|
74
|
+
font-size: 1.1rem;
|
|
75
|
+
}
|
|
76
|
+
.auth-btn:hover {
|
|
77
|
+
background: var(--bg-secondary);
|
|
78
|
+
color: var(--text-primary);
|
|
79
|
+
}
|
|
80
|
+
</style>
|
|
81
|
+
|
|
82
|
+
|
|
21
83
|
<!-- Favicon -->
|
|
22
|
-
<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
|
|
84
|
+
<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>">
|
|
85
|
+
|
|
86
|
+
<script type="application/ld+json">
|
|
87
|
+
{
|
|
88
|
+
"@context": "https://schema.org",
|
|
89
|
+
"@type": "TechArticle",
|
|
90
|
+
"headline": "SEO Guide for @knowcode/doc-builder",
|
|
91
|
+
"description": "@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and look...",
|
|
92
|
+
"author": {
|
|
93
|
+
"@type": "Person",
|
|
94
|
+
"name": "Lindsay Smith"
|
|
95
|
+
},
|
|
96
|
+
"publisher": {
|
|
97
|
+
"@type": "Organization",
|
|
98
|
+
"name": "Knowcode Ltd",
|
|
99
|
+
"url": "https://knowcode.tech"
|
|
100
|
+
},
|
|
101
|
+
"datePublished": "2025-07-28T16:34:27.940Z",
|
|
102
|
+
"dateModified": "2025-07-28T16:34:27.940Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/seo-guide.html"
|
|
106
|
+
},
|
|
107
|
+
"breadcrumb": {
|
|
108
|
+
"@type": "BreadcrumbList",
|
|
109
|
+
"itemListElement": [
|
|
110
|
+
{
|
|
111
|
+
"@type": "ListItem",
|
|
112
|
+
"position": 1,
|
|
113
|
+
"name": "@knowcode/doc-builder",
|
|
114
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"@type": "ListItem",
|
|
118
|
+
"position": 2,
|
|
119
|
+
"name": "Guides",
|
|
120
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"@type": "ListItem",
|
|
124
|
+
"position": 3,
|
|
125
|
+
"name": "Seo Guide",
|
|
126
|
+
"item": "https://doc-builder-delta.vercel.app/guides/seo-guide.html"
|
|
127
|
+
}
|
|
128
|
+
]
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
</script>
|
|
23
132
|
</head>
|
|
24
133
|
<body>
|
|
25
134
|
<!-- Header -->
|
|
@@ -29,10 +138,14 @@
|
|
|
29
138
|
|
|
30
139
|
<div class="header-actions">
|
|
31
140
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
141
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.3">Last updated: Jul 28, 2025, 04:34 PM UTC</span>
|
|
33
142
|
</div>
|
|
34
143
|
|
|
35
144
|
|
|
145
|
+
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
+
</a>
|
|
148
|
+
|
|
36
149
|
|
|
37
150
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
151
|
<i class="fas fa-moon"></i>
|
|
@@ -92,16 +205,18 @@
|
|
|
92
205
|
<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="fas fa-file-alt"></i> Authentication Guide</a>
|
|
93
206
|
<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>
|
|
94
207
|
<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>
|
|
208
|
+
<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="fas fa-file-alt"></i> Html Embedding Guide</a>
|
|
95
209
|
<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="fas fa-file-alt"></i> Image Modal Guide</a>
|
|
96
210
|
<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="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
97
211
|
<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="fas fa-file-alt"></i> Private Directory Authentication</a>
|
|
212
|
+
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="fas fa-file-alt"></i> Private Directory Authentication Troubleshooting</a>
|
|
98
213
|
<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="fas fa-file-alt"></i> Public Site Deployment</a>
|
|
99
214
|
<a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="fas fa-file-alt"></i> Search Engine Verification Guide</a>
|
|
100
215
|
<a href="/guides/seo-guide.html" class="nav-item active" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
|
|
101
216
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
102
217
|
<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>
|
|
103
218
|
<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="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
104
|
-
<div class="nav-section" data-level="1">
|
|
219
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
220
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
106
221
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
222
|
</a>
|
|
@@ -114,7 +229,7 @@
|
|
|
114
229
|
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
115
230
|
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
|
|
116
231
|
<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="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
117
|
-
<div class="nav-section" data-level="2">
|
|
232
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
233
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
234
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
235
|
</a>
|
|
@@ -520,7 +635,17 @@ author: Different Author
|
|
|
520
635
|
</div>
|
|
521
636
|
|
|
522
637
|
<!-- Scripts -->
|
|
638
|
+
<script>
|
|
639
|
+
// Pass configuration to frontend
|
|
640
|
+
window.docBuilderConfig = {
|
|
641
|
+
features: {
|
|
642
|
+
showPdfDownload: true,
|
|
643
|
+
menuDefaultOpen: false
|
|
644
|
+
}
|
|
645
|
+
};
|
|
646
|
+
</script>
|
|
523
647
|
<script src="/js/main.js"></script>
|
|
524
|
-
|
|
648
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
649
|
+
<script src="/js/auth.js"></script>
|
|
525
650
|
</body>
|
|
526
651
|
</html>
|
|
@@ -3,14 +3,41 @@
|
|
|
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>SEO Optimization Guide
|
|
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="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="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings.">
|
|
19
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
+
<meta property="og:site_name" content="@knowcode/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="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your 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
|
+
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
8
34
|
|
|
9
35
|
<!-- Fonts -->
|
|
10
36
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
11
37
|
|
|
12
38
|
<!-- Icons -->
|
|
13
39
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
40
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
14
41
|
|
|
15
42
|
<!-- Mermaid -->
|
|
16
43
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -18,8 +45,90 @@
|
|
|
18
45
|
<!-- Styles -->
|
|
19
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
47
|
|
|
48
|
+
|
|
49
|
+
<!-- Hide content until auth check -->
|
|
50
|
+
<style>
|
|
51
|
+
body {
|
|
52
|
+
visibility: hidden;
|
|
53
|
+
opacity: 0;
|
|
54
|
+
transition: opacity 0.3s ease;
|
|
55
|
+
}
|
|
56
|
+
body.authenticated {
|
|
57
|
+
visibility: visible;
|
|
58
|
+
opacity: 1;
|
|
59
|
+
}
|
|
60
|
+
/* Show login/logout pages immediately */
|
|
61
|
+
body.auth-page {
|
|
62
|
+
visibility: visible;
|
|
63
|
+
opacity: 1;
|
|
64
|
+
}
|
|
65
|
+
/* Style auth button consistently */
|
|
66
|
+
.auth-btn {
|
|
67
|
+
background: none;
|
|
68
|
+
border: none;
|
|
69
|
+
color: var(--text-secondary);
|
|
70
|
+
cursor: pointer;
|
|
71
|
+
padding: 0.5rem;
|
|
72
|
+
border-radius: 0.5rem;
|
|
73
|
+
transition: all 0.2s;
|
|
74
|
+
font-size: 1.1rem;
|
|
75
|
+
}
|
|
76
|
+
.auth-btn:hover {
|
|
77
|
+
background: var(--bg-secondary);
|
|
78
|
+
color: var(--text-primary);
|
|
79
|
+
}
|
|
80
|
+
</style>
|
|
81
|
+
|
|
82
|
+
|
|
21
83
|
<!-- Favicon -->
|
|
22
|
-
<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
|
|
84
|
+
<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>">
|
|
85
|
+
|
|
86
|
+
<script type="application/ld+json">
|
|
87
|
+
{
|
|
88
|
+
"@context": "https://schema.org",
|
|
89
|
+
"@type": "TechArticle",
|
|
90
|
+
"headline": "SEO Optimization Guide for @knowcode/doc-builder",
|
|
91
|
+
"description": "Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings.",
|
|
92
|
+
"author": {
|
|
93
|
+
"@type": "Person",
|
|
94
|
+
"name": "Lindsay Smith"
|
|
95
|
+
},
|
|
96
|
+
"publisher": {
|
|
97
|
+
"@type": "Organization",
|
|
98
|
+
"name": "Knowcode Ltd",
|
|
99
|
+
"url": "https://knowcode.tech"
|
|
100
|
+
},
|
|
101
|
+
"datePublished": "2025-07-28T16:34:27.946Z",
|
|
102
|
+
"dateModified": "2025-07-28T16:34:27.946Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
|
|
106
|
+
},
|
|
107
|
+
"breadcrumb": {
|
|
108
|
+
"@type": "BreadcrumbList",
|
|
109
|
+
"itemListElement": [
|
|
110
|
+
{
|
|
111
|
+
"@type": "ListItem",
|
|
112
|
+
"position": 1,
|
|
113
|
+
"name": "@knowcode/doc-builder",
|
|
114
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"@type": "ListItem",
|
|
118
|
+
"position": 2,
|
|
119
|
+
"name": "Guides",
|
|
120
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"@type": "ListItem",
|
|
124
|
+
"position": 3,
|
|
125
|
+
"name": "Seo Optimization Guide",
|
|
126
|
+
"item": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
|
|
127
|
+
}
|
|
128
|
+
]
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
</script>
|
|
23
132
|
</head>
|
|
24
133
|
<body>
|
|
25
134
|
<!-- Header -->
|
|
@@ -29,10 +138,14 @@
|
|
|
29
138
|
|
|
30
139
|
<div class="header-actions">
|
|
31
140
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
141
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.3">Last updated: Jul 28, 2025, 04:34 PM UTC</span>
|
|
33
142
|
</div>
|
|
34
143
|
|
|
35
144
|
|
|
145
|
+
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
+
</a>
|
|
148
|
+
|
|
36
149
|
|
|
37
150
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
151
|
<i class="fas fa-moon"></i>
|
|
@@ -92,16 +205,18 @@
|
|
|
92
205
|
<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="fas fa-file-alt"></i> Authentication Guide</a>
|
|
93
206
|
<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>
|
|
94
207
|
<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>
|
|
208
|
+
<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="fas fa-file-alt"></i> Html Embedding Guide</a>
|
|
95
209
|
<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="fas fa-file-alt"></i> Image Modal Guide</a>
|
|
96
210
|
<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="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
97
211
|
<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="fas fa-file-alt"></i> Private Directory Authentication</a>
|
|
212
|
+
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="fas fa-file-alt"></i> Private Directory Authentication Troubleshooting</a>
|
|
98
213
|
<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="fas fa-file-alt"></i> Public Site Deployment</a>
|
|
99
214
|
<a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="fas fa-file-alt"></i> Search Engine Verification Guide</a>
|
|
100
215
|
<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>
|
|
101
216
|
<a href="/guides/seo-optimization-guide.html" class="nav-item active" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
102
217
|
<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>
|
|
103
218
|
<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="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
104
|
-
<div class="nav-section" data-level="1">
|
|
219
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
220
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
106
221
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
222
|
</a>
|
|
@@ -114,7 +229,7 @@
|
|
|
114
229
|
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
115
230
|
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
|
|
116
231
|
<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="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
117
|
-
<div class="nav-section" data-level="2">
|
|
232
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
233
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
234
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
235
|
</a>
|
|
@@ -138,9 +253,7 @@
|
|
|
138
253
|
<!-- Content Area -->
|
|
139
254
|
<main class="content">
|
|
140
255
|
<div class="content-inner">
|
|
141
|
-
<
|
|
142
|
-
<h2>title: "SEO Optimization Guide for @knowcode/doc-builder"<br>description: "Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."<br>keywords: ["SEO", "documentation", "optimization", "front matter", "meta tags", "search engines", "doc-builder"]<br>author: "Doc Builder Team"<br>date: "2025-07-22"</h2>
|
|
143
|
-
<h1>SEO Optimization Guide</h1>
|
|
256
|
+
<h1>SEO Optimization Guide</h1>
|
|
144
257
|
<h2>Overview</h2>
|
|
145
258
|
<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>
|
|
146
259
|
<h2>Why SEO Matters for Documentation</h2>
|
|
@@ -274,15 +387,15 @@ keywords: ["authentication", "security", "password prot
|
|
|
274
387
|
<h3>Examples</h3>
|
|
275
388
|
<p>Good titles:</p>
|
|
276
389
|
<ul>
|
|
277
|
-
<li
|
|
278
|
-
<li
|
|
279
|
-
<li
|
|
390
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> "Authentication Guide | Doc Builder" (38 chars)</li>
|
|
391
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> "SEO Best Practices for Documentation | MyDocs" (45 chars)</li>
|
|
392
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> "Quick Start: Deploy to Vercel | Doc Builder" (43 chars)</li>
|
|
280
393
|
</ul>
|
|
281
394
|
<p>Bad titles:</p>
|
|
282
395
|
<ul>
|
|
283
|
-
<li
|
|
284
|
-
<li
|
|
285
|
-
<li
|
|
396
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Guide" (5 chars - too short)</li>
|
|
397
|
+
<li><i 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>
|
|
398
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Page Title | Site Name | Category | Subcategory" (keyword stuffing)</li>
|
|
286
399
|
</ul>
|
|
287
400
|
<h2>Meta Descriptions</h2>
|
|
288
401
|
<h3>Best Practices</h3>
|
|
@@ -304,13 +417,13 @@ keywords: ["authentication", "security", "password prot
|
|
|
304
417
|
<h3>Examples</h3>
|
|
305
418
|
<p>Good descriptions:</p>
|
|
306
419
|
<ul>
|
|
307
|
-
<li
|
|
308
|
-
<li
|
|
420
|
+
<li><i 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>
|
|
421
|
+
<li><i 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>
|
|
309
422
|
</ul>
|
|
310
423
|
<p>Bad descriptions:</p>
|
|
311
424
|
<ul>
|
|
312
|
-
<li
|
|
313
|
-
<li
|
|
425
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "This page is about authentication." (35 chars - too short)</li>
|
|
426
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Authentication authentication authentication..." (keyword stuffing)</li>
|
|
314
427
|
</ul>
|
|
315
428
|
<h2>Keywords Strategy</h2>
|
|
316
429
|
<h3>Modern Keyword Approach (2025)</h3>
|
|
@@ -354,14 +467,14 @@ doc-builder seo-check html/guide.html
|
|
|
354
467
|
<h3>What It Analyzes in HTML</h3>
|
|
355
468
|
<p>The command inspects the actual HTML output that search engines see:</p>
|
|
356
469
|
<ul>
|
|
357
|
-
<li
|
|
358
|
-
<li
|
|
359
|
-
<li
|
|
360
|
-
<li
|
|
361
|
-
<li
|
|
362
|
-
<li
|
|
363
|
-
<li
|
|
364
|
-
<li
|
|
470
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Title tags</strong> - Presence and optimal length (50-60 chars)</li>
|
|
471
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Meta descriptions</strong> - Quality and character count (140-160)</li>
|
|
472
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Keywords meta tag</strong> - Presence of relevant keywords</li>
|
|
473
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Canonical URLs</strong> - Prevents duplicate content penalties</li>
|
|
474
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>H1 tags</strong> - Ensures proper heading structure</li>
|
|
475
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Open Graph tags</strong> - Social media optimization</li>
|
|
476
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Twitter Card tags</strong> - Twitter/X optimization</li>
|
|
477
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Structured data</strong> - JSON-LD implementation</li>
|
|
365
478
|
</ul>
|
|
366
479
|
<h3>Example Output</h3>
|
|
367
480
|
<pre><code>🔍 Analyzing SEO in generated HTML files...
|
|
@@ -444,28 +557,28 @@ Your content here...
|
|
|
444
557
|
<h2>Common SEO Mistakes to Avoid</h2>
|
|
445
558
|
<h3>1. Duplicate Content</h3>
|
|
446
559
|
<ul>
|
|
447
|
-
<li
|
|
448
|
-
<li
|
|
560
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Same description on multiple pages</li>
|
|
561
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Unique descriptions for each page</li>
|
|
449
562
|
</ul>
|
|
450
563
|
<h3>2. Keyword Stuffing</h3>
|
|
451
564
|
<ul>
|
|
452
|
-
<li
|
|
453
|
-
<li
|
|
565
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Guide guide documentation guide tutorial guide"</li>
|
|
566
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Natural keyword usage in context</li>
|
|
454
567
|
</ul>
|
|
455
568
|
<h3>3. Ignoring Mobile</h3>
|
|
456
569
|
<ul>
|
|
457
|
-
<li
|
|
458
|
-
<li
|
|
570
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Long titles that get cut off on mobile</li>
|
|
571
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Test how titles appear on different devices</li>
|
|
459
572
|
</ul>
|
|
460
573
|
<h3>4. Missing Descriptions</h3>
|
|
461
574
|
<ul>
|
|
462
|
-
<li
|
|
463
|
-
<li
|
|
575
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Leaving description blank</li>
|
|
576
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Always provide meaningful descriptions</li>
|
|
464
577
|
</ul>
|
|
465
578
|
<h3>5. Generic Titles</h3>
|
|
466
579
|
<ul>
|
|
467
|
-
<li
|
|
468
|
-
<li
|
|
580
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Documentation", "Guide", "Page 1"</li>
|
|
581
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Specific, descriptive titles</li>
|
|
469
582
|
</ul>
|
|
470
583
|
<h2>SEO Checklist</h2>
|
|
471
584
|
<p>Before publishing, ensure:</p>
|
|
@@ -748,7 +861,17 @@ doc-builder deploy
|
|
|
748
861
|
</div>
|
|
749
862
|
|
|
750
863
|
<!-- Scripts -->
|
|
864
|
+
<script>
|
|
865
|
+
// Pass configuration to frontend
|
|
866
|
+
window.docBuilderConfig = {
|
|
867
|
+
features: {
|
|
868
|
+
showPdfDownload: true,
|
|
869
|
+
menuDefaultOpen: false
|
|
870
|
+
}
|
|
871
|
+
};
|
|
872
|
+
</script>
|
|
751
873
|
<script src="/js/main.js"></script>
|
|
752
|
-
|
|
874
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
875
|
+
<script src="/js/auth.js"></script>
|
|
753
876
|
</body>
|
|
754
877
|
</html>
|