@knowcode/doc-builder 1.5.2 → 1.5.4
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/.claude/settings.local.json +2 -1
- package/CHANGELOG.md +33 -0
- package/README.md +7 -30
- package/assets/css/notion-style.css +22 -2
- package/assets/js/main.js +53 -29
- package/cli.js +73 -0
- package/doc-builder.config.js +7 -1
- package/html/README.html +7 -3
- package/html/css/notion-style.css +22 -2
- package/html/documentation-index.html +7 -3
- package/html/guides/authentication-guide.html +7 -3
- package/html/guides/claude-workflow-guide.html +7 -3
- package/html/guides/documentation-standards.html +7 -3
- package/html/guides/google-site-verification-guide.html +338 -0
- package/html/guides/seo-guide.html +7 -3
- package/html/guides/troubleshooting-guide.html +7 -3
- package/html/index.html +7 -3
- package/html/js/main.js +53 -29
- package/html/sitemap.xml +19 -13
- package/html/vercel-cli-setup-guide.html +7 -3
- package/html/vercel-first-time-setup-guide.html +7 -3
- package/lib/core-builder.js +2 -1
- package/lib/seo.js +14 -1
- package/package.json +4 -2
- package/publish.sh +198 -0
|
@@ -0,0 +1,338 @@
|
|
|
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="Google Site Verification Guide.">
|
|
7
|
+
<title>Google Site Verification Guide - Doc Builder</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, your, verification, search, google, site">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/google-site-verification-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/google-site-verification-guide.html">
|
|
17
|
+
<meta property="og:title" content="Google Site Verification Guide - Doc Builder">
|
|
18
|
+
<meta property="og:description" content="Google Site Verification Guide.">
|
|
19
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
+
<meta property="og:site_name" content="Doc Builder">
|
|
21
|
+
<meta property="og:locale" content="en_US">
|
|
22
|
+
|
|
23
|
+
<!-- Twitter Card -->
|
|
24
|
+
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
+
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
+
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
+
<meta name="twitter:title" content="Google Site Verification Guide - Doc Builder">
|
|
28
|
+
<meta name="twitter:description" content="Google Site Verification Guide.">
|
|
29
|
+
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
|
+
|
|
31
|
+
<!-- Custom Meta Tags -->
|
|
32
|
+
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
|
|
34
|
+
<!-- Fonts -->
|
|
35
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
36
|
+
|
|
37
|
+
<!-- Icons -->
|
|
38
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
39
|
+
|
|
40
|
+
<!-- Mermaid -->
|
|
41
|
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
42
|
+
|
|
43
|
+
<!-- Styles -->
|
|
44
|
+
<link rel="stylesheet" href="/css/notion-style.css">
|
|
45
|
+
|
|
46
|
+
<!-- Favicon -->
|
|
47
|
+
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
48
|
+
|
|
49
|
+
<script type="application/ld+json">
|
|
50
|
+
{
|
|
51
|
+
"@context": "https://schema.org",
|
|
52
|
+
"@type": "TechArticle",
|
|
53
|
+
"headline": "Google Site Verification Guide",
|
|
54
|
+
"description": "Google Site Verification Guide.",
|
|
55
|
+
"author": {
|
|
56
|
+
"@type": "Person",
|
|
57
|
+
"name": "Lindsay Smith"
|
|
58
|
+
},
|
|
59
|
+
"publisher": {
|
|
60
|
+
"@type": "Organization",
|
|
61
|
+
"name": "Knowcode Ltd",
|
|
62
|
+
"url": "https://knowcode.tech"
|
|
63
|
+
},
|
|
64
|
+
"datePublished": "2025-07-22T06:56:56.790Z",
|
|
65
|
+
"dateModified": "2025-07-22T06:56:56.790Z",
|
|
66
|
+
"mainEntityOfPage": {
|
|
67
|
+
"@type": "WebPage",
|
|
68
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/google-site-verification-guide.html"
|
|
69
|
+
},
|
|
70
|
+
"breadcrumb": {
|
|
71
|
+
"@type": "BreadcrumbList",
|
|
72
|
+
"itemListElement": [
|
|
73
|
+
{
|
|
74
|
+
"@type": "ListItem",
|
|
75
|
+
"position": 1,
|
|
76
|
+
"name": "Doc Builder",
|
|
77
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"@type": "ListItem",
|
|
81
|
+
"position": 2,
|
|
82
|
+
"name": "Guides",
|
|
83
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"@type": "ListItem",
|
|
87
|
+
"position": 3,
|
|
88
|
+
"name": "Google Site Verification Guide",
|
|
89
|
+
"item": "https://doc-builder-delta.vercel.app/guides/google-site-verification-guide.html"
|
|
90
|
+
}
|
|
91
|
+
]
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
</script>
|
|
95
|
+
</head>
|
|
96
|
+
<body>
|
|
97
|
+
<!-- Header -->
|
|
98
|
+
<header class="header">
|
|
99
|
+
<div class="header-content">
|
|
100
|
+
<a href="/index.html" class="logo">Doc Builder</a>
|
|
101
|
+
|
|
102
|
+
<div class="header-actions">
|
|
103
|
+
<div class="deployment-info">
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.3">Last updated: Jul 22, 2025, 06:56 AM UTC</span>
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
110
|
+
<i class="fas fa-moon"></i>
|
|
111
|
+
</button>
|
|
112
|
+
|
|
113
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
114
|
+
<i class="fas fa-bars"></i>
|
|
115
|
+
</button>
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
</header>
|
|
119
|
+
|
|
120
|
+
<!-- Preview Banner -->
|
|
121
|
+
<div id="preview-banner" class="preview-banner">
|
|
122
|
+
<div class="banner-content">
|
|
123
|
+
<i class="fas fa-exclamation-triangle banner-icon"></i>
|
|
124
|
+
<span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
|
|
125
|
+
<button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
|
|
126
|
+
<i class="fas fa-times"></i>
|
|
127
|
+
</button>
|
|
128
|
+
</div>
|
|
129
|
+
</div>
|
|
130
|
+
|
|
131
|
+
<!-- Breadcrumbs -->
|
|
132
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
133
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
134
|
+
</nav>
|
|
135
|
+
|
|
136
|
+
<!-- Main Content -->
|
|
137
|
+
<div class="main-wrapper">
|
|
138
|
+
<!-- Sidebar -->
|
|
139
|
+
<aside class="sidebar">
|
|
140
|
+
<div class="sidebar-header">
|
|
141
|
+
<div class="filter-box">
|
|
142
|
+
<input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
|
|
143
|
+
<i class="fas fa-search filter-icon"></i>
|
|
144
|
+
</div>
|
|
145
|
+
</div>
|
|
146
|
+
<nav class="navigation">
|
|
147
|
+
|
|
148
|
+
<div class="nav-section" data-level="0">
|
|
149
|
+
<a class="nav-title" href="/README.html" >
|
|
150
|
+
<i class="fas fa-home"></i> Documentation
|
|
151
|
+
</a>
|
|
152
|
+
<div class="nav-content" >
|
|
153
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
154
|
+
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
155
|
+
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
156
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you'll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
157
|
+
<div class="nav-section" data-level="1">
|
|
158
|
+
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
159
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
160
|
+
</a>
|
|
161
|
+
<div class="nav-content" id="nav-guides-1">
|
|
162
|
+
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
163
|
+
<a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
164
|
+
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
165
|
+
<a href="/guides/google-site-verification-guide.html" class="nav-item active" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
166
|
+
<a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
|
|
167
|
+
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
|
|
168
|
+
</nav>
|
|
169
|
+
<div class="resize-handle"></div>
|
|
170
|
+
</aside>
|
|
171
|
+
|
|
172
|
+
<!-- Content Area -->
|
|
173
|
+
<main class="content">
|
|
174
|
+
<div class="content-inner">
|
|
175
|
+
<h1>Google Site Verification Guide</h1>
|
|
176
|
+
<p>This guide explains how to verify your documentation site with Google Search Console using @knowcode/doc-builder.</p>
|
|
177
|
+
<h2>Overview</h2>
|
|
178
|
+
<p>Google Search Console verification allows you to:</p>
|
|
179
|
+
<ul>
|
|
180
|
+
<li>Monitor your site's performance in Google Search</li>
|
|
181
|
+
<li>Submit sitemaps for better indexing</li>
|
|
182
|
+
<li>View search analytics and keywords</li>
|
|
183
|
+
<li>Identify and fix crawl errors</li>
|
|
184
|
+
<li>Receive alerts about site issues</li>
|
|
185
|
+
</ul>
|
|
186
|
+
<h2>Prerequisites</h2>
|
|
187
|
+
<ul>
|
|
188
|
+
<li>@knowcode/doc-builder v1.5.4 or higher</li>
|
|
189
|
+
<li>Access to Google Search Console</li>
|
|
190
|
+
<li>A deployed documentation site</li>
|
|
191
|
+
</ul>
|
|
192
|
+
<h2>Step 1: Get Your Verification Code</h2>
|
|
193
|
+
<ol>
|
|
194
|
+
<li>Go to <a href="https://search.google.com/search-console">Google Search Console</a></li>
|
|
195
|
+
<li>Click "Add property" and enter your documentation site URL</li>
|
|
196
|
+
<li>Choose the "HTML tag" verification method</li>
|
|
197
|
+
<li>Copy the verification code from the meta tag:<pre><code class="language-html"><meta name="google-site-verification" content="YOUR_VERIFICATION_CODE" />
|
|
198
|
+
</code></pre>
|
|
199
|
+
</li>
|
|
200
|
+
<li>You only need the content value (e.g., <code>FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ</code>)</li>
|
|
201
|
+
</ol>
|
|
202
|
+
<h2>Step 2: Add Verification to Your Site</h2>
|
|
203
|
+
<p>Use the doc-builder CLI to add the verification meta tag:</p>
|
|
204
|
+
<pre><code class="language-bash">doc-builder google-verify YOUR_VERIFICATION_CODE
|
|
205
|
+
</code></pre>
|
|
206
|
+
<p>Example:</p>
|
|
207
|
+
<pre><code class="language-bash">doc-builder google-verify FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ
|
|
208
|
+
</code></pre>
|
|
209
|
+
<p>This command will:</p>
|
|
210
|
+
<ul>
|
|
211
|
+
<li>Update your <code>doc-builder.config.js</code> file</li>
|
|
212
|
+
<li>Add the verification meta tag to the SEO configuration</li>
|
|
213
|
+
<li>Show confirmation of the added tag</li>
|
|
214
|
+
</ul>
|
|
215
|
+
<h2>Step 3: Rebuild and Deploy</h2>
|
|
216
|
+
<p>After adding the verification code, rebuild and deploy your documentation:</p>
|
|
217
|
+
<pre><code class="language-bash"># Rebuild the documentation
|
|
218
|
+
doc-builder build
|
|
219
|
+
|
|
220
|
+
# Deploy to production
|
|
221
|
+
doc-builder deploy
|
|
222
|
+
</code></pre>
|
|
223
|
+
<h2>Step 4: Complete Verification</h2>
|
|
224
|
+
<ol>
|
|
225
|
+
<li>Return to Google Search Console</li>
|
|
226
|
+
<li>Click "Verify" on the verification page</li>
|
|
227
|
+
<li>Google will check for the meta tag on your site</li>
|
|
228
|
+
<li>Once verified, you'll have access to all Search Console features</li>
|
|
229
|
+
</ol>
|
|
230
|
+
<h2>Configuration Details</h2>
|
|
231
|
+
<p>The verification code is stored in your config file under <code>seo.customMetaTags</code>:</p>
|
|
232
|
+
<pre><code class="language-javascript">module.exports = {
|
|
233
|
+
// ... other config
|
|
234
|
+
seo: {
|
|
235
|
+
enabled: true,
|
|
236
|
+
customMetaTags: [
|
|
237
|
+
{
|
|
238
|
+
name: "google-site-verification",
|
|
239
|
+
content: "YOUR_VERIFICATION_CODE"
|
|
240
|
+
}
|
|
241
|
+
]
|
|
242
|
+
}
|
|
243
|
+
};
|
|
244
|
+
</code></pre>
|
|
245
|
+
<h2>Multiple Verifications</h2>
|
|
246
|
+
<p>You can add multiple verification codes or other custom meta tags:</p>
|
|
247
|
+
<pre><code class="language-javascript">seo: {
|
|
248
|
+
customMetaTags: [
|
|
249
|
+
{
|
|
250
|
+
name: "google-site-verification",
|
|
251
|
+
content: "GOOGLE_CODE"
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
name: "bing-site-verification",
|
|
255
|
+
content: "BING_CODE"
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
name: "yandex-verification",
|
|
259
|
+
content: "YANDEX_CODE"
|
|
260
|
+
}
|
|
261
|
+
]
|
|
262
|
+
}
|
|
263
|
+
</code></pre>
|
|
264
|
+
<h2>Updating Verification Code</h2>
|
|
265
|
+
<p>To update an existing verification code, simply run the command again with the new code:</p>
|
|
266
|
+
<pre><code class="language-bash">doc-builder google-verify NEW_VERIFICATION_CODE
|
|
267
|
+
</code></pre>
|
|
268
|
+
<h2>Troubleshooting</h2>
|
|
269
|
+
<h3>Verification Failed</h3>
|
|
270
|
+
<p>If Google can't verify your site:</p>
|
|
271
|
+
<ol>
|
|
272
|
+
<li><strong>Check deployment status</strong>: Ensure your site is deployed and accessible</li>
|
|
273
|
+
<li><strong>View page source</strong>: Verify the meta tag appears in the <code><head></code> section</li>
|
|
274
|
+
<li><strong>Clear cache</strong>: If using a CDN, clear the cache and wait a few minutes</li>
|
|
275
|
+
<li><strong>Check URL</strong>: Ensure you're verifying the exact URL (with or without www)</li>
|
|
276
|
+
</ol>
|
|
277
|
+
<h3>Meta Tag Not Appearing</h3>
|
|
278
|
+
<p>If the meta tag doesn't appear in your HTML:</p>
|
|
279
|
+
<ol>
|
|
280
|
+
<li>Rebuild your documentation: <code>doc-builder build</code></li>
|
|
281
|
+
<li>Check your config file for syntax errors</li>
|
|
282
|
+
<li>Ensure SEO is enabled in your configuration</li>
|
|
283
|
+
<li>Verify the deployment includes the latest changes</li>
|
|
284
|
+
</ol>
|
|
285
|
+
<h3>Manual Configuration</h3>
|
|
286
|
+
<p>You can also manually add the verification to your config:</p>
|
|
287
|
+
<ol>
|
|
288
|
+
<li>Open <code>doc-builder.config.js</code></li>
|
|
289
|
+
<li>Add or update the SEO section:<pre><code class="language-javascript">seo: {
|
|
290
|
+
enabled: true,
|
|
291
|
+
customMetaTags: [
|
|
292
|
+
{
|
|
293
|
+
name: "google-site-verification",
|
|
294
|
+
content: "YOUR_VERIFICATION_CODE"
|
|
295
|
+
}
|
|
296
|
+
]
|
|
297
|
+
}
|
|
298
|
+
</code></pre>
|
|
299
|
+
</li>
|
|
300
|
+
<li>Save and rebuild your documentation</li>
|
|
301
|
+
</ol>
|
|
302
|
+
<h2>Best Practices</h2>
|
|
303
|
+
<ol>
|
|
304
|
+
<li><strong>Keep verification active</strong>: Don't remove the meta tag after verification</li>
|
|
305
|
+
<li><strong>Add site URL</strong>: Configure <code>seo.siteUrl</code> in your config for better SEO</li>
|
|
306
|
+
<li><strong>Submit sitemap</strong>: After verification, submit your sitemap.xml</li>
|
|
307
|
+
<li><strong>Monitor regularly</strong>: Check Search Console weekly for issues</li>
|
|
308
|
+
<li><strong>Multiple owners</strong>: Add team members as additional owners in Search Console</li>
|
|
309
|
+
</ol>
|
|
310
|
+
<h2>Related Features</h2>
|
|
311
|
+
<ul>
|
|
312
|
+
<li><strong>Sitemap generation</strong>: Automatically generated at <code>/sitemap.xml</code></li>
|
|
313
|
+
<li><strong>robots.txt</strong>: Automatically generated with proper directives</li>
|
|
314
|
+
<li><strong>SEO optimization</strong>: Built-in meta tags and structured data</li>
|
|
315
|
+
<li><strong>Production URL</strong>: Set with <code>doc-builder set-production-url</code></li>
|
|
316
|
+
</ul>
|
|
317
|
+
<h2>Security Note</h2>
|
|
318
|
+
<p>Your verification code is specific to your Google account and domain. It's safe to commit to your repository as it only grants access to Search Console data, not your Google account.</p>
|
|
319
|
+
<h2>Next Steps</h2>
|
|
320
|
+
<p>After verification:</p>
|
|
321
|
+
<ol>
|
|
322
|
+
<li>Submit your sitemap in Search Console</li>
|
|
323
|
+
<li>Set up email alerts for crawl errors</li>
|
|
324
|
+
<li>Monitor search performance and impressions</li>
|
|
325
|
+
<li>Use the data to improve your documentation SEO</li>
|
|
326
|
+
</ol>
|
|
327
|
+
<hr>
|
|
328
|
+
<p>For more information about Google Search Console, visit the <a href="https://support.google.com/webmasters">official documentation</a>.</p>
|
|
329
|
+
|
|
330
|
+
</div>
|
|
331
|
+
</main>
|
|
332
|
+
</div>
|
|
333
|
+
|
|
334
|
+
<!-- Scripts -->
|
|
335
|
+
<script src="/js/main.js"></script>
|
|
336
|
+
|
|
337
|
+
</body>
|
|
338
|
+
</html>
|
|
@@ -28,6 +28,9 @@
|
|
|
28
28
|
<meta name="twitter:description" content="SEO Guide for @knowcode/doc-builder.">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
|
+
<!-- Custom Meta Tags -->
|
|
32
|
+
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
|
|
31
34
|
<!-- Fonts -->
|
|
32
35
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
33
36
|
|
|
@@ -58,8 +61,8 @@
|
|
|
58
61
|
"name": "Knowcode Ltd",
|
|
59
62
|
"url": "https://knowcode.tech"
|
|
60
63
|
},
|
|
61
|
-
"datePublished": "2025-07-
|
|
62
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T06:56:56.793Z",
|
|
65
|
+
"dateModified": "2025-07-22T06:56:56.793Z",
|
|
63
66
|
"mainEntityOfPage": {
|
|
64
67
|
"@type": "WebPage",
|
|
65
68
|
"@id": "https://doc-builder-delta.vercel.app/guides/seo-guide.html"
|
|
@@ -98,7 +101,7 @@
|
|
|
98
101
|
|
|
99
102
|
<div class="header-actions">
|
|
100
103
|
<div class="deployment-info">
|
|
101
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.3">Last updated: Jul 22, 2025, 06:56 AM UTC</span>
|
|
102
105
|
</div>
|
|
103
106
|
|
|
104
107
|
|
|
@@ -159,6 +162,7 @@
|
|
|
159
162
|
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
160
163
|
<a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
161
164
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
165
|
+
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
162
166
|
<a href="/guides/seo-guide.html" class="nav-item active" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
|
|
163
167
|
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
|
|
164
168
|
</nav>
|
|
@@ -28,6 +28,9 @@
|
|
|
28
28
|
<meta name="twitter:description" content="Troubleshooting Guide for @knowcode/doc-builder.">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
|
+
<!-- Custom Meta Tags -->
|
|
32
|
+
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
|
|
31
34
|
<!-- Fonts -->
|
|
32
35
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
33
36
|
|
|
@@ -58,8 +61,8 @@
|
|
|
58
61
|
"name": "Knowcode Ltd",
|
|
59
62
|
"url": "https://knowcode.tech"
|
|
60
63
|
},
|
|
61
|
-
"datePublished": "2025-07-
|
|
62
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T06:56:56.796Z",
|
|
65
|
+
"dateModified": "2025-07-22T06:56:56.796Z",
|
|
63
66
|
"mainEntityOfPage": {
|
|
64
67
|
"@type": "WebPage",
|
|
65
68
|
"@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
|
|
@@ -98,7 +101,7 @@
|
|
|
98
101
|
|
|
99
102
|
<div class="header-actions">
|
|
100
103
|
<div class="deployment-info">
|
|
101
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
104
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.3">Last updated: Jul 22, 2025, 06:56 AM UTC</span>
|
|
102
105
|
</div>
|
|
103
106
|
|
|
104
107
|
|
|
@@ -159,6 +162,7 @@
|
|
|
159
162
|
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
160
163
|
<a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
161
164
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
165
|
+
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
162
166
|
<a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
|
|
163
167
|
<a href="/guides/troubleshooting-guide.html" class="nav-item active" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
|
|
164
168
|
</nav>
|
package/html/index.html
CHANGED
|
@@ -28,6 +28,9 @@
|
|
|
28
28
|
<meta name="twitter:description" content="@knowcode/doc-builder.">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
|
+
<!-- Custom Meta Tags -->
|
|
32
|
+
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
|
|
31
34
|
<!-- Fonts -->
|
|
32
35
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
33
36
|
|
|
@@ -58,8 +61,8 @@
|
|
|
58
61
|
"name": "Knowcode Ltd",
|
|
59
62
|
"url": "https://knowcode.tech"
|
|
60
63
|
},
|
|
61
|
-
"datePublished": "2025-07-
|
|
62
|
-
"dateModified": "2025-07-
|
|
64
|
+
"datePublished": "2025-07-22T06:56:56.764Z",
|
|
65
|
+
"dateModified": "2025-07-22T06:56:56.764Z",
|
|
63
66
|
"mainEntityOfPage": {
|
|
64
67
|
"@type": "WebPage",
|
|
65
68
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -92,7 +95,7 @@
|
|
|
92
95
|
|
|
93
96
|
<div class="header-actions">
|
|
94
97
|
<div class="deployment-info">
|
|
95
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
98
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.3">Last updated: Jul 22, 2025, 06:56 AM UTC</span>
|
|
96
99
|
</div>
|
|
97
100
|
|
|
98
101
|
|
|
@@ -153,6 +156,7 @@
|
|
|
153
156
|
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
154
157
|
<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>
|
|
155
158
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
159
|
+
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
156
160
|
<a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
|
|
157
161
|
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
|
|
158
162
|
</nav>
|
package/html/js/main.js
CHANGED
|
@@ -512,9 +512,28 @@ function updateThemeIcon(theme) {
|
|
|
512
512
|
const menuToggle = document.getElementById('menu-toggle');
|
|
513
513
|
const sidebar = document.querySelector('.sidebar');
|
|
514
514
|
|
|
515
|
+
// Create overlay element for mobile
|
|
516
|
+
let overlay = document.querySelector('.sidebar-overlay');
|
|
517
|
+
if (!overlay && window.innerWidth <= 768) {
|
|
518
|
+
overlay = document.createElement('div');
|
|
519
|
+
overlay.className = 'sidebar-overlay';
|
|
520
|
+
document.body.appendChild(overlay);
|
|
521
|
+
}
|
|
522
|
+
|
|
515
523
|
if (menuToggle) {
|
|
516
524
|
menuToggle.addEventListener('click', () => {
|
|
517
525
|
sidebar.classList.toggle('open');
|
|
526
|
+
if (overlay) {
|
|
527
|
+
overlay.classList.toggle('active');
|
|
528
|
+
}
|
|
529
|
+
});
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
// Close menu when clicking overlay
|
|
533
|
+
if (overlay) {
|
|
534
|
+
overlay.addEventListener('click', () => {
|
|
535
|
+
sidebar.classList.remove('open');
|
|
536
|
+
overlay.classList.remove('active');
|
|
518
537
|
});
|
|
519
538
|
}
|
|
520
539
|
|
|
@@ -532,7 +551,8 @@ function initFloatingMenuButton() {
|
|
|
532
551
|
floatingButton.className = 'floating-menu-toggle';
|
|
533
552
|
floatingButton.setAttribute('aria-label', 'Toggle menu');
|
|
534
553
|
floatingButton.innerHTML = '<i class="fas fa-bars"></i>';
|
|
535
|
-
floatingButton.style.display = '
|
|
554
|
+
floatingButton.style.display = 'flex'; // Always visible on mobile
|
|
555
|
+
floatingButton.classList.add('visible'); // Start visible
|
|
536
556
|
|
|
537
557
|
// Add to body
|
|
538
558
|
document.body.appendChild(floatingButton);
|
|
@@ -540,6 +560,26 @@ function initFloatingMenuButton() {
|
|
|
540
560
|
// Toggle sidebar on click
|
|
541
561
|
floatingButton.addEventListener('click', () => {
|
|
542
562
|
sidebar.classList.toggle('open');
|
|
563
|
+
|
|
564
|
+
// Handle overlay
|
|
565
|
+
let overlay = document.querySelector('.sidebar-overlay');
|
|
566
|
+
if (!overlay) {
|
|
567
|
+
overlay = document.createElement('div');
|
|
568
|
+
overlay.className = 'sidebar-overlay';
|
|
569
|
+
document.body.appendChild(overlay);
|
|
570
|
+
|
|
571
|
+
// Add overlay click handler
|
|
572
|
+
overlay.addEventListener('click', () => {
|
|
573
|
+
sidebar.classList.remove('open');
|
|
574
|
+
overlay.classList.remove('active');
|
|
575
|
+
floatingButton.querySelector('i').className = 'fas fa-bars';
|
|
576
|
+
});
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
if (overlay) {
|
|
580
|
+
overlay.classList.toggle('active');
|
|
581
|
+
}
|
|
582
|
+
|
|
543
583
|
// Update icon based on state
|
|
544
584
|
const icon = floatingButton.querySelector('i');
|
|
545
585
|
if (sidebar.classList.contains('open')) {
|
|
@@ -549,33 +589,7 @@ function initFloatingMenuButton() {
|
|
|
549
589
|
}
|
|
550
590
|
});
|
|
551
591
|
|
|
552
|
-
//
|
|
553
|
-
let scrollTimeout;
|
|
554
|
-
|
|
555
|
-
window.addEventListener('scroll', () => {
|
|
556
|
-
clearTimeout(scrollTimeout);
|
|
557
|
-
scrollTimeout = setTimeout(() => {
|
|
558
|
-
const scrollTop = window.pageYOffset || document.documentElement.scrollTop;
|
|
559
|
-
const headerHeight = document.querySelector('.header')?.offsetHeight || 64;
|
|
560
|
-
|
|
561
|
-
// Show floating button when scrolled past header
|
|
562
|
-
if (scrollTop > headerHeight + 50) {
|
|
563
|
-
floatingButton.style.display = 'flex';
|
|
564
|
-
// Add slight delay for smooth appearance
|
|
565
|
-
setTimeout(() => {
|
|
566
|
-
floatingButton.classList.add('visible');
|
|
567
|
-
}, 10);
|
|
568
|
-
} else {
|
|
569
|
-
floatingButton.classList.remove('visible');
|
|
570
|
-
// Hide after transition completes
|
|
571
|
-
setTimeout(() => {
|
|
572
|
-
if (!floatingButton.classList.contains('visible')) {
|
|
573
|
-
floatingButton.style.display = 'none';
|
|
574
|
-
}
|
|
575
|
-
}, 300);
|
|
576
|
-
}
|
|
577
|
-
}, 100);
|
|
578
|
-
});
|
|
592
|
+
// Remove scroll-based visibility - button is always visible on mobile
|
|
579
593
|
|
|
580
594
|
// Update icon when sidebar state changes from other sources
|
|
581
595
|
const observer = new MutationObserver(() => {
|
|
@@ -611,11 +625,21 @@ document.addEventListener('click', (e) => {
|
|
|
611
625
|
if (window.innerWidth <= 768) {
|
|
612
626
|
const isClickInsideSidebar = sidebar && sidebar.contains(e.target);
|
|
613
627
|
const isMenuToggle = e.target.closest('#menu-toggle');
|
|
628
|
+
const isFloatingButton = e.target.closest('#floating-menu-toggle');
|
|
614
629
|
const isNavItem = e.target.closest('.nav-item, .nav-title');
|
|
630
|
+
const overlay = document.querySelector('.sidebar-overlay');
|
|
615
631
|
|
|
616
632
|
// Close sidebar only if clicking outside AND not on menu toggle AND not on nav items
|
|
617
|
-
if (!isClickInsideSidebar && !isMenuToggle && !isNavItem && sidebar?.classList.contains('open')) {
|
|
633
|
+
if (!isClickInsideSidebar && !isMenuToggle && !isFloatingButton && !isNavItem && sidebar?.classList.contains('open')) {
|
|
618
634
|
sidebar.classList.remove('open');
|
|
635
|
+
if (overlay) {
|
|
636
|
+
overlay.classList.remove('active');
|
|
637
|
+
}
|
|
638
|
+
// Update floating button icon if it exists
|
|
639
|
+
const floatingBtn = document.getElementById('floating-menu-toggle');
|
|
640
|
+
if (floatingBtn) {
|
|
641
|
+
floatingBtn.querySelector('i').className = 'fas fa-bars';
|
|
642
|
+
}
|
|
619
643
|
}
|
|
620
644
|
}
|
|
621
645
|
});
|