@knowcode/doc-builder 1.9.30 → 1.10.0
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/lib/core-builder.js +164 -174
- package/lib/emoji-mapper.js +27 -12
- 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,661 +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="@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="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, your">
|
|
12
|
-
<meta name="robots" content="index, follow">
|
|
13
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/seo-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-guide.html">
|
|
18
|
-
<meta property="og:title" content="SEO Guide for @knowcode/doc-builder | @knowcode/doc-builder">
|
|
19
|
-
<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...">
|
|
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 Guide for @knowcode/doc-builder | @knowcode/doc-builder">
|
|
29
|
-
<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...">
|
|
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 Guide for @knowcode/doc-builder",
|
|
94
|
-
"description": "@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and look...",
|
|
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.388Z",
|
|
105
|
-
"dateModified": "2025-08-12T21:40:09.388Z",
|
|
106
|
-
"mainEntityOfPage": {
|
|
107
|
-
"@type": "WebPage",
|
|
108
|
-
"@id": "https://doc-builder-delta.vercel.app/guides/seo-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 Guide",
|
|
129
|
-
"item": "https://doc-builder-delta.vercel.app/guides/seo-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 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="ph ph-check-circle" style="color: #059669;"></i> Seo Guide</a>
|
|
214
|
-
<a href="/guides/seo-optimization-guide.html" class="nav-item" 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 Guide for @knowcode/doc-builder</h1>
|
|
266
|
-
<h2>Overview</h2>
|
|
267
|
-
<p>@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and look great when shared on social media. This guide covers all SEO features and how to configure them.</p>
|
|
268
|
-
<h2>Quick Start</h2>
|
|
269
|
-
<p>Run the SEO setup wizard to configure all SEO settings interactively:</p>
|
|
270
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest setup-seo
|
|
271
|
-
</code></pre>
|
|
272
|
-
<h2>SEO Features</h2>
|
|
273
|
-
<h3>1. Meta Tags</h3>
|
|
274
|
-
<p>Every generated HTML page includes comprehensive meta tags:</p>
|
|
275
|
-
<ul>
|
|
276
|
-
<li><strong>Author</strong> - Document author attribution</li>
|
|
277
|
-
<li><strong>Keywords</strong> - Relevant keywords (auto-extracted or manual)</li>
|
|
278
|
-
<li><strong>Description</strong> - Page description (auto-generated or custom)</li>
|
|
279
|
-
<li><strong>Canonical URL</strong> - Prevents duplicate content issues</li>
|
|
280
|
-
<li><strong>Robots</strong> - Search engine crawling instructions</li>
|
|
281
|
-
<li><strong>Language</strong> - Content language specification</li>
|
|
282
|
-
</ul>
|
|
283
|
-
<h3>2. Open Graph Tags</h3>
|
|
284
|
-
<p>For rich social media previews on:</p>
|
|
285
|
-
<ul>
|
|
286
|
-
<li>Facebook</li>
|
|
287
|
-
<li>LinkedIn</li>
|
|
288
|
-
<li>Slack</li>
|
|
289
|
-
<li>Teams</li>
|
|
290
|
-
<li>Discord</li>
|
|
291
|
-
</ul>
|
|
292
|
-
<p>Includes:</p>
|
|
293
|
-
<ul>
|
|
294
|
-
<li><code>og:title</code> - Page title</li>
|
|
295
|
-
<li><code>og:description</code> - Page description</li>
|
|
296
|
-
<li><code>og:image</code> - Preview image</li>
|
|
297
|
-
<li><code>og:url</code> - Canonical URL</li>
|
|
298
|
-
<li><code>og:type</code> - Content type (article)</li>
|
|
299
|
-
<li><code>og:site_name</code> - Your site name</li>
|
|
300
|
-
<li><code>og:locale</code> - Language/region</li>
|
|
301
|
-
</ul>
|
|
302
|
-
<h3>3. Twitter Card Tags</h3>
|
|
303
|
-
<p>Optimized Twitter sharing with:</p>
|
|
304
|
-
<ul>
|
|
305
|
-
<li><code>twitter:card</code> - Large image preview</li>
|
|
306
|
-
<li><code>twitter:site</code> - Your Twitter handle</li>
|
|
307
|
-
<li><code>twitter:creator</code> - Content creator</li>
|
|
308
|
-
<li><code>twitter:title</code> - Tweet title</li>
|
|
309
|
-
<li><code>twitter:description</code> - Tweet description</li>
|
|
310
|
-
<li><code>twitter:image</code> - Preview image</li>
|
|
311
|
-
</ul>
|
|
312
|
-
<h3>4. JSON-LD Structured Data</h3>
|
|
313
|
-
<p>Schema.org structured data for better search understanding:</p>
|
|
314
|
-
<ul>
|
|
315
|
-
<li><strong>TechArticle</strong> - For technical documentation</li>
|
|
316
|
-
<li><strong>BreadcrumbList</strong> - Navigation hierarchy</li>
|
|
317
|
-
<li><strong>Organization</strong> - Publisher information</li>
|
|
318
|
-
<li><strong>WebPage</strong> - Page metadata</li>
|
|
319
|
-
</ul>
|
|
320
|
-
<h3>5. Automatic Sitemap Generation</h3>
|
|
321
|
-
<ul>
|
|
322
|
-
<li><code>sitemap.xml</code> generated during build</li>
|
|
323
|
-
<li>Includes all HTML pages</li>
|
|
324
|
-
<li>Priority and change frequency</li>
|
|
325
|
-
<li>Automatic lastmod dates</li>
|
|
326
|
-
</ul>
|
|
327
|
-
<h3>6. Robots.txt</h3>
|
|
328
|
-
<ul>
|
|
329
|
-
<li>Crawler instructions</li>
|
|
330
|
-
<li>Sitemap location</li>
|
|
331
|
-
<li>Authentication page exclusions</li>
|
|
332
|
-
<li>Custom rules support</li>
|
|
333
|
-
</ul>
|
|
334
|
-
<h2>Configuration</h2>
|
|
335
|
-
<h3>Using the Setup Wizard</h3>
|
|
336
|
-
<p>The easiest way to configure SEO is using the interactive wizard:</p>
|
|
337
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest setup-seo
|
|
338
|
-
</code></pre>
|
|
339
|
-
<p>You'll be prompted for:</p>
|
|
340
|
-
<ol>
|
|
341
|
-
<li><strong>Site URL</strong> - Your production URL (e.g., <a href="https://docs.example.com">https://docs.example.com</a>)</li>
|
|
342
|
-
<li><strong>Author Name</strong> - Default author for pages</li>
|
|
343
|
-
<li><strong>Twitter Handle</strong> - Your Twitter username</li>
|
|
344
|
-
<li><strong>Site Language</strong> - Content language (default: en-US)</li>
|
|
345
|
-
<li><strong>Organization Name</strong> - Your company/project name</li>
|
|
346
|
-
<li><strong>Default OG Image</strong> - Social media preview image</li>
|
|
347
|
-
<li><strong>Keywords</strong> - Default keywords for all pages</li>
|
|
348
|
-
<li><strong>Sitemap Generation</strong> - Enable/disable sitemap.xml</li>
|
|
349
|
-
<li><strong>Robots.txt Generation</strong> - Enable/disable robots.txt</li>
|
|
350
|
-
</ol>
|
|
351
|
-
<h3>Manual Configuration</h3>
|
|
352
|
-
<p>Add SEO settings to your <code>doc-builder.config.js</code>:</p>
|
|
353
|
-
<pre><code class="language-javascript">module.exports = {
|
|
354
|
-
// ... other config ...
|
|
355
|
-
|
|
356
|
-
seo: {
|
|
357
|
-
enabled: true,
|
|
358
|
-
siteUrl: 'https://docs.example.com',
|
|
359
|
-
author: 'Your Name',
|
|
360
|
-
twitterHandle: '@yourhandle',
|
|
361
|
-
language: 'en-US',
|
|
362
|
-
keywords: ['documentation', 'api', 'guide'],
|
|
363
|
-
organization: {
|
|
364
|
-
name: 'Your Company',
|
|
365
|
-
url: 'https://example.com',
|
|
366
|
-
logo: 'https://example.com/logo.png'
|
|
367
|
-
},
|
|
368
|
-
ogImage: '/og-default.png',
|
|
369
|
-
generateSitemap: true,
|
|
370
|
-
generateRobotsTxt: true,
|
|
371
|
-
customMetaTags: [
|
|
372
|
-
'<meta name="custom-tag" content="value">'
|
|
373
|
-
]
|
|
374
|
-
}
|
|
375
|
-
}
|
|
376
|
-
</code></pre>
|
|
377
|
-
<h3>Configuration Options</h3>
|
|
378
|
-
<table>
|
|
379
|
-
<thead>
|
|
380
|
-
<tr>
|
|
381
|
-
<th>Option</th>
|
|
382
|
-
<th>Type</th>
|
|
383
|
-
<th>Description</th>
|
|
384
|
-
<th>Default</th>
|
|
385
|
-
</tr>
|
|
386
|
-
</thead>
|
|
387
|
-
<tbody><tr>
|
|
388
|
-
<td><code>enabled</code></td>
|
|
389
|
-
<td>boolean</td>
|
|
390
|
-
<td>Enable/disable all SEO features</td>
|
|
391
|
-
<td><code>true</code></td>
|
|
392
|
-
</tr>
|
|
393
|
-
<tr>
|
|
394
|
-
<td><code>siteUrl</code></td>
|
|
395
|
-
<td>string</td>
|
|
396
|
-
<td>Your production URL (required)</td>
|
|
397
|
-
<td>-</td>
|
|
398
|
-
</tr>
|
|
399
|
-
<tr>
|
|
400
|
-
<td><code>author</code></td>
|
|
401
|
-
<td>string</td>
|
|
402
|
-
<td>Default author name</td>
|
|
403
|
-
<td>-</td>
|
|
404
|
-
</tr>
|
|
405
|
-
<tr>
|
|
406
|
-
<td><code>twitterHandle</code></td>
|
|
407
|
-
<td>string</td>
|
|
408
|
-
<td>Twitter username (with or without @)</td>
|
|
409
|
-
<td>-</td>
|
|
410
|
-
</tr>
|
|
411
|
-
<tr>
|
|
412
|
-
<td><code>language</code></td>
|
|
413
|
-
<td>string</td>
|
|
414
|
-
<td>Content language code</td>
|
|
415
|
-
<td><code>'en-US'</code></td>
|
|
416
|
-
</tr>
|
|
417
|
-
<tr>
|
|
418
|
-
<td><code>keywords</code></td>
|
|
419
|
-
<td>array</td>
|
|
420
|
-
<td>Default keywords for all pages</td>
|
|
421
|
-
<td><code>[]</code></td>
|
|
422
|
-
</tr>
|
|
423
|
-
<tr>
|
|
424
|
-
<td><code>organization</code></td>
|
|
425
|
-
<td>object</td>
|
|
426
|
-
<td>Company/project information</td>
|
|
427
|
-
<td>-</td>
|
|
428
|
-
</tr>
|
|
429
|
-
<tr>
|
|
430
|
-
<td><code>ogImage</code></td>
|
|
431
|
-
<td>string</td>
|
|
432
|
-
<td>Default Open Graph image URL/path</td>
|
|
433
|
-
<td>-</td>
|
|
434
|
-
</tr>
|
|
435
|
-
<tr>
|
|
436
|
-
<td><code>generateSitemap</code></td>
|
|
437
|
-
<td>boolean</td>
|
|
438
|
-
<td>Generate sitemap.xml</td>
|
|
439
|
-
<td><code>true</code></td>
|
|
440
|
-
</tr>
|
|
441
|
-
<tr>
|
|
442
|
-
<td><code>generateRobotsTxt</code></td>
|
|
443
|
-
<td>boolean</td>
|
|
444
|
-
<td>Generate robots.txt</td>
|
|
445
|
-
<td><code>true</code></td>
|
|
446
|
-
</tr>
|
|
447
|
-
<tr>
|
|
448
|
-
<td><code>customMetaTags</code></td>
|
|
449
|
-
<td>array</td>
|
|
450
|
-
<td>Additional meta tags</td>
|
|
451
|
-
<td><code>[]</code></td>
|
|
452
|
-
</tr>
|
|
453
|
-
</tbody></table>
|
|
454
|
-
<h2>Best Practices</h2>
|
|
455
|
-
<h3>1. Open Graph Images</h3>
|
|
456
|
-
<ul>
|
|
457
|
-
<li><strong>Recommended size</strong>: 1200×630 pixels</li>
|
|
458
|
-
<li><strong>Format</strong>: PNG or JPG</li>
|
|
459
|
-
<li><strong>Content</strong>: Include your logo and site name</li>
|
|
460
|
-
<li><strong>Location</strong>: Place in <code>/html</code> directory</li>
|
|
461
|
-
</ul>
|
|
462
|
-
<h3>2. Keywords</h3>
|
|
463
|
-
<ul>
|
|
464
|
-
<li>Use 5-10 relevant keywords</li>
|
|
465
|
-
<li>Include product names, technologies</li>
|
|
466
|
-
<li>Avoid keyword stuffing</li>
|
|
467
|
-
<li>Keywords are auto-extracted from content if not specified</li>
|
|
468
|
-
</ul>
|
|
469
|
-
<h3>3. Descriptions</h3>
|
|
470
|
-
<ul>
|
|
471
|
-
<li>Keep under 160 characters</li>
|
|
472
|
-
<li>Make them compelling and accurate</li>
|
|
473
|
-
<li>Auto-generated from first paragraph if not specified</li>
|
|
474
|
-
</ul>
|
|
475
|
-
<h3>4. Site URL</h3>
|
|
476
|
-
<ul>
|
|
477
|
-
<li>Always use HTTPS</li>
|
|
478
|
-
<li>Include trailing slash for consistency</li>
|
|
479
|
-
<li>Must match your production deployment</li>
|
|
480
|
-
</ul>
|
|
481
|
-
<h3>5. Twitter Handle</h3>
|
|
482
|
-
<ul>
|
|
483
|
-
<li>Include the @ symbol or not (both work)</li>
|
|
484
|
-
<li>Use your official account</li>
|
|
485
|
-
<li>Helps with attribution and engagement</li>
|
|
486
|
-
</ul>
|
|
487
|
-
<h2>Per-Page SEO</h2>
|
|
488
|
-
<p>While doc-builder provides site-wide SEO settings, you can override them per page using frontmatter (coming in future version):</p>
|
|
489
|
-
<pre><code class="language-markdown">---
|
|
490
|
-
title: Custom Page Title
|
|
491
|
-
description: Custom meta description for this page
|
|
492
|
-
keywords: [custom, keywords, for, this, page]
|
|
493
|
-
author: Different Author
|
|
494
|
-
---
|
|
495
|
-
|
|
496
|
-
# Page Content
|
|
497
|
-
</code></pre>
|
|
498
|
-
<h2>Verification</h2>
|
|
499
|
-
<h3>1. Build with SEO</h3>
|
|
500
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest build
|
|
501
|
-
</code></pre>
|
|
502
|
-
<p>You'll see SEO generation in the output:</p>
|
|
503
|
-
<pre><code>🗺️ Generating sitemap.xml...
|
|
504
|
-
✅ Generated sitemap.xml with 23 URLs
|
|
505
|
-
🤖 Generating robots.txt...
|
|
506
|
-
✅ Generated robots.txt
|
|
507
|
-
</code></pre>
|
|
508
|
-
<h3>2. Check Generated Files</h3>
|
|
509
|
-
<ul>
|
|
510
|
-
<li>View <code>html/sitemap.xml</code> for all page URLs</li>
|
|
511
|
-
<li>View <code>html/robots.txt</code> for crawler instructions</li>
|
|
512
|
-
<li>Inspect any HTML file to see meta tags</li>
|
|
513
|
-
</ul>
|
|
514
|
-
<h3>3. Test Your SEO</h3>
|
|
515
|
-
<p>Use these tools to verify your SEO implementation:</p>
|
|
516
|
-
<ul>
|
|
517
|
-
<li><strong><a href="https://metatags.io">Meta Tags Preview</a></strong> - Preview social media cards</li>
|
|
518
|
-
<li><strong><a href="https://cards-dev.twitter.com/validator">Twitter Card Validator</a></strong> - Test Twitter cards</li>
|
|
519
|
-
<li><strong><a href="https://developers.facebook.com/tools/debug/">Facebook Debugger</a></strong> - Test Open Graph tags</li>
|
|
520
|
-
<li><strong><a href="https://search.google.com/test/rich-results">Google Rich Results Test</a></strong> - Test structured data</li>
|
|
521
|
-
</ul>
|
|
522
|
-
<h3>4. View Page Source</h3>
|
|
523
|
-
<p>Check any generated HTML page for:</p>
|
|
524
|
-
<pre><code class="language-html"><!-- Look for these sections -->
|
|
525
|
-
<!-- Open Graph / Facebook -->
|
|
526
|
-
<!-- Twitter Card -->
|
|
527
|
-
<script type="application/ld+json">
|
|
528
|
-
</code></pre>
|
|
529
|
-
<h2>Sitemap Submission</h2>
|
|
530
|
-
<p>After deployment, submit your sitemap to search engines:</p>
|
|
531
|
-
<h3>Google Search Console</h3>
|
|
532
|
-
<ol>
|
|
533
|
-
<li>Go to <a href="https://search.google.com/search-console">Google Search Console</a></li>
|
|
534
|
-
<li>Add your site property</li>
|
|
535
|
-
<li>Navigate to Sitemaps</li>
|
|
536
|
-
<li>Enter: <code>sitemap.xml</code></li>
|
|
537
|
-
<li>Click Submit</li>
|
|
538
|
-
</ol>
|
|
539
|
-
<h3>Bing Webmaster Tools</h3>
|
|
540
|
-
<ol>
|
|
541
|
-
<li>Go to <a href="https://www.bing.com/webmasters">Bing Webmaster Tools</a></li>
|
|
542
|
-
<li>Add your site</li>
|
|
543
|
-
<li>Submit sitemap URL</li>
|
|
544
|
-
</ol>
|
|
545
|
-
<h2>Troubleshooting</h2>
|
|
546
|
-
<h3>SEO Not Generating</h3>
|
|
547
|
-
<ul>
|
|
548
|
-
<li>Ensure <code>seo.enabled: true</code> in config</li>
|
|
549
|
-
<li>Check that <code>siteUrl</code> is set</li>
|
|
550
|
-
<li>Run <code>setup-seo</code> command again</li>
|
|
551
|
-
</ul>
|
|
552
|
-
<h3>Wrong URLs in Sitemap</h3>
|
|
553
|
-
<ul>
|
|
554
|
-
<li>Verify <code>siteUrl</code> matches your deployment</li>
|
|
555
|
-
<li>Don't include <code>/html</code> in the URL</li>
|
|
556
|
-
<li>Use production URL, not localhost</li>
|
|
557
|
-
</ul>
|
|
558
|
-
<h3>Missing Meta Tags</h3>
|
|
559
|
-
<ul>
|
|
560
|
-
<li>Check browser DevTools for errors</li>
|
|
561
|
-
<li>Ensure build completed successfully</li>
|
|
562
|
-
<li>Verify config file syntax</li>
|
|
563
|
-
</ul>
|
|
564
|
-
<h3>Social Preview Not Working</h3>
|
|
565
|
-
<ul>
|
|
566
|
-
<li>Image must be publicly accessible</li>
|
|
567
|
-
<li>Use absolute URLs for images</li>
|
|
568
|
-
<li>Clear social media cache (use debugger tools)</li>
|
|
569
|
-
</ul>
|
|
570
|
-
<h2>Example Output</h2>
|
|
571
|
-
<p>Here's what doc-builder generates for each page:</p>
|
|
572
|
-
<pre><code class="language-html"><!-- Standard Meta Tags -->
|
|
573
|
-
<meta name="author" content="Lindsay Smith">
|
|
574
|
-
<meta name="keywords" content="documentation, markdown, static site">
|
|
575
|
-
<meta name="robots" content="index, follow">
|
|
576
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/seo-guide.html">
|
|
577
|
-
|
|
578
|
-
<!-- Open Graph / Facebook -->
|
|
579
|
-
<meta property="og:type" content="article">
|
|
580
|
-
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/seo-guide.html">
|
|
581
|
-
<meta property="og:title" content="SEO Guide - Documentation">
|
|
582
|
-
<meta property="og:description" content="Complete guide to SEO features in doc-builder">
|
|
583
|
-
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
584
|
-
<meta property="og:site_name" content="Documentation">
|
|
585
|
-
<meta property="og:locale" content="en_US">
|
|
586
|
-
|
|
587
|
-
<!-- Twitter Card -->
|
|
588
|
-
<meta name="twitter:card" content="summary_large_image">
|
|
589
|
-
<meta name="twitter:site" content="@planbbackups">
|
|
590
|
-
<meta name="twitter:creator" content="@planbbackups">
|
|
591
|
-
<meta name="twitter:title" content="SEO Guide - Documentation">
|
|
592
|
-
<meta name="twitter:description" content="Complete guide to SEO features in doc-builder">
|
|
593
|
-
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
594
|
-
|
|
595
|
-
<!-- JSON-LD Structured Data -->
|
|
596
|
-
<script type="application/ld+json">
|
|
597
|
-
{
|
|
598
|
-
"@context": "https://schema.org",
|
|
599
|
-
"@type": "TechArticle",
|
|
600
|
-
"headline": "SEO Guide",
|
|
601
|
-
"description": "Complete guide to SEO features in doc-builder",
|
|
602
|
-
"author": {
|
|
603
|
-
"@type": "Person",
|
|
604
|
-
"name": "Lindsay Smith"
|
|
605
|
-
},
|
|
606
|
-
"publisher": {
|
|
607
|
-
"@type": "Organization",
|
|
608
|
-
"name": "KnowCode",
|
|
609
|
-
"url": "https://knowcode.com"
|
|
610
|
-
},
|
|
611
|
-
"datePublished": "2025-01-21T10:00:00Z",
|
|
612
|
-
"dateModified": "2025-01-21T10:00:00Z",
|
|
613
|
-
"mainEntityOfPage": {
|
|
614
|
-
"@type": "WebPage",
|
|
615
|
-
"@id": "https://doc-builder-delta.vercel.app/guides/seo-guide.html"
|
|
616
|
-
}
|
|
617
|
-
}
|
|
618
|
-
</script>
|
|
619
|
-
</code></pre>
|
|
620
|
-
<h2>Future Enhancements</h2>
|
|
621
|
-
<p>Planned SEO features for future versions:</p>
|
|
622
|
-
<ul>
|
|
623
|
-
<li>Page-specific SEO via frontmatter</li>
|
|
624
|
-
<li>Automatic Open Graph image generation</li>
|
|
625
|
-
<li>Multiple language support (hreflang)</li>
|
|
626
|
-
<li>Video metadata support</li>
|
|
627
|
-
<li>FAQ schema for Q&A sections</li>
|
|
628
|
-
<li>How-to schema for tutorials</li>
|
|
629
|
-
<li>Search box schema</li>
|
|
630
|
-
<li>Local business schema support</li>
|
|
631
|
-
</ul>
|
|
632
|
-
<h2>Conclusion</h2>
|
|
633
|
-
<p>With @knowcode/doc-builder's SEO features, your documentation will:</p>
|
|
634
|
-
<ul>
|
|
635
|
-
<li>Rank better in search results</li>
|
|
636
|
-
<li>Look professional when shared</li>
|
|
637
|
-
<li>Be properly indexed by search engines</li>
|
|
638
|
-
<li>Provide rich previews on social media</li>
|
|
639
|
-
</ul>
|
|
640
|
-
<p>Run <code>npx @knowcode/doc-builder@latest setup-seo</code> to get started!</p>
|
|
641
|
-
|
|
642
|
-
</div>
|
|
643
|
-
</main>
|
|
644
|
-
</div>
|
|
645
|
-
|
|
646
|
-
<!-- Scripts -->
|
|
647
|
-
<script>
|
|
648
|
-
// Pass configuration to frontend
|
|
649
|
-
window.docBuilderConfig = {
|
|
650
|
-
features: {
|
|
651
|
-
showPdfDownload: true,
|
|
652
|
-
menuDefaultOpen: false,
|
|
653
|
-
mermaidEnhanced: true
|
|
654
|
-
}
|
|
655
|
-
};
|
|
656
|
-
</script>
|
|
657
|
-
<script src="/js/main.js"></script>
|
|
658
|
-
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
659
|
-
<script src="/js/auth.js"></script>
|
|
660
|
-
</body>
|
|
661
|
-
</html>
|