@knowcode/doc-builder 1.5.22 → 1.6.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/README.md +2 -8
- package/cli.js +73 -0
- package/doc-builder.config.js +5 -1
- package/html/README.html +25 -18
- package/html/css/notion-style.css +3 -3
- package/html/documentation-index.html +12 -11
- package/html/guides/authentication-guide.html +14 -13
- package/html/guides/claude-workflow-guide.html +9 -8
- package/html/guides/documentation-standards.html +12 -11
- package/html/guides/phosphor-icons-guide.html +12 -11
- package/html/guides/{google-site-verification-guide.html → search-engine-verification-guide.html} +147 -43
- package/html/guides/seo-guide.html +12 -11
- package/html/guides/seo-optimization-guide.html +10 -9
- package/html/guides/troubleshooting-guide.html +9 -8
- package/html/guides/windows-setup-guide.html +9 -8
- package/html/index.html +25 -18
- package/html/launch/README.html +12 -11
- package/html/launch/bubble-plugin-specification.html +12 -11
- package/html/launch/go-to-market-strategy.html +12 -11
- package/html/launch/launch-announcements.html +12 -11
- package/html/sitemap.xml +27 -21
- package/html/vercel-cli-setup-guide.html +12 -11
- package/html/vercel-first-time-setup-guide.html +53 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -64,7 +64,6 @@ This aligns perfectly with our mission: beautiful documentation should be access
|
|
|
64
64
|
- 🚀 **Zero Configuration** - Works out of the box
|
|
65
65
|
- 📝 **Markdown Support** - Full GitHub Flavored Markdown
|
|
66
66
|
- 🎨 **Beautiful Theme** - Notion-inspired design
|
|
67
|
-
- 🔄 **Live Reload** - Hot reloading dev server
|
|
68
67
|
- 📦 **Self-Contained** - No setup required
|
|
69
68
|
- 🤖 **Claude Code Ready** - AI-optimized workflows
|
|
70
69
|
|
|
@@ -147,9 +146,6 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
147
146
|
# Build static HTML
|
|
148
147
|
npx @knowcode/doc-builder@latest build
|
|
149
148
|
|
|
150
|
-
# Development server
|
|
151
|
-
npx @knowcode/doc-builder@latest dev
|
|
152
|
-
|
|
153
149
|
# Show help
|
|
154
150
|
npx @knowcode/doc-builder@latest
|
|
155
151
|
```
|
|
@@ -166,7 +162,6 @@ npm install --save-dev @knowcode/doc-builder@latest
|
|
|
166
162
|
# Use shorter commands
|
|
167
163
|
doc-builder deploy
|
|
168
164
|
doc-builder build
|
|
169
|
-
doc-builder dev
|
|
170
165
|
doc-builder --help
|
|
171
166
|
```
|
|
172
167
|
*Better for regular use & offline access*
|
|
@@ -206,8 +201,8 @@ module.exports = {
|
|
|
206
201
|
outputDir: 'html',
|
|
207
202
|
|
|
208
203
|
// Site info
|
|
209
|
-
siteName: '
|
|
210
|
-
siteDescription: '
|
|
204
|
+
siteName: '@knowcode/doc-builder',
|
|
205
|
+
siteDescription: 'Transform markdown into beautiful documentation',
|
|
211
206
|
|
|
212
207
|
// Production URL (optional)
|
|
213
208
|
productionUrl: 'https://my-docs.vercel.app', // Custom URL to display after deployment
|
|
@@ -238,7 +233,6 @@ module.exports = {
|
|
|
238
233
|
| Command | Purpose |
|
|
239
234
|
|---------|---------|
|
|
240
235
|
| `build` | Generate static HTML |
|
|
241
|
-
| `dev` | Start dev server |
|
|
242
236
|
| `deploy` | Deploy to Vercel |
|
|
243
237
|
| `init` | Initialize project |
|
|
244
238
|
|
package/cli.js
CHANGED
|
@@ -193,6 +193,79 @@ ${chalk.yellow('Get your verification code from Google Search Console.')}
|
|
|
193
193
|
}
|
|
194
194
|
});
|
|
195
195
|
|
|
196
|
+
// Bing Site Verification command
|
|
197
|
+
program
|
|
198
|
+
.command('bing-verify <verification-code>')
|
|
199
|
+
.description('Add Bing site verification meta tag to all pages')
|
|
200
|
+
.option('-c, --config <path>', 'path to config file (default: doc-builder.config.js)')
|
|
201
|
+
.addHelpText('after', `
|
|
202
|
+
${chalk.yellow('Examples:')}
|
|
203
|
+
${chalk.gray('$')} doc-builder bing-verify B2D8C4C12C530D47AA962B24CAA09630
|
|
204
|
+
${chalk.gray('$')} doc-builder bing-verify YOUR_VERIFICATION_CODE
|
|
205
|
+
|
|
206
|
+
${chalk.yellow('This will add the Bing site verification meta tag to all generated HTML pages.')}
|
|
207
|
+
${chalk.yellow('Get your verification code from Bing Webmaster Tools.')}
|
|
208
|
+
`)
|
|
209
|
+
.action(async (verificationCode, options) => {
|
|
210
|
+
try {
|
|
211
|
+
const configPath = path.join(process.cwd(), options.config || 'doc-builder.config.js');
|
|
212
|
+
let config;
|
|
213
|
+
|
|
214
|
+
if (fs.existsSync(configPath)) {
|
|
215
|
+
// Load existing config
|
|
216
|
+
delete require.cache[require.resolve(configPath)];
|
|
217
|
+
config = require(configPath);
|
|
218
|
+
} else {
|
|
219
|
+
console.log(chalk.yellow('⚠️ No config file found. Creating one...'));
|
|
220
|
+
await createDefaultConfig();
|
|
221
|
+
config = require(configPath);
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
// Ensure SEO section exists
|
|
225
|
+
if (!config.seo) {
|
|
226
|
+
config.seo = {
|
|
227
|
+
enabled: true,
|
|
228
|
+
customMetaTags: []
|
|
229
|
+
};
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
if (!config.seo.customMetaTags) {
|
|
233
|
+
config.seo.customMetaTags = [];
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
// Check if Bing verification already exists
|
|
237
|
+
const bingVerifyIndex = config.seo.customMetaTags.findIndex(tag =>
|
|
238
|
+
tag.name === 'msvalidate.01'
|
|
239
|
+
);
|
|
240
|
+
|
|
241
|
+
const newTag = {
|
|
242
|
+
name: 'msvalidate.01',
|
|
243
|
+
content: verificationCode
|
|
244
|
+
};
|
|
245
|
+
|
|
246
|
+
if (bingVerifyIndex >= 0) {
|
|
247
|
+
// Update existing
|
|
248
|
+
config.seo.customMetaTags[bingVerifyIndex] = newTag;
|
|
249
|
+
console.log(chalk.green(`✅ Updated Bing site verification code`));
|
|
250
|
+
} else {
|
|
251
|
+
// Add new
|
|
252
|
+
config.seo.customMetaTags.push(newTag);
|
|
253
|
+
console.log(chalk.green(`✅ Added Bing site verification code`));
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
// Write updated config
|
|
257
|
+
const configContent = `module.exports = ${JSON.stringify(config, null, 2)};\n`;
|
|
258
|
+
fs.writeFileSync(configPath, configContent);
|
|
259
|
+
|
|
260
|
+
console.log(chalk.gray(`\nThe following meta tag will be added to all pages:`));
|
|
261
|
+
console.log(chalk.cyan(`<meta name="msvalidate.01" content="${verificationCode}" />`));
|
|
262
|
+
console.log(chalk.gray(`\nRun ${chalk.cyan('doc-builder build')} to regenerate your documentation.`));
|
|
263
|
+
} catch (error) {
|
|
264
|
+
console.error(chalk.red('Failed to add Bing verification:'), error.message);
|
|
265
|
+
process.exit(1);
|
|
266
|
+
}
|
|
267
|
+
});
|
|
268
|
+
|
|
196
269
|
// SEO Check command
|
|
197
270
|
program
|
|
198
271
|
.command('seo-check [path]')
|
package/doc-builder.config.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
module.exports = {
|
|
2
|
-
"siteName": "
|
|
2
|
+
"siteName": "@knowcode/doc-builder",
|
|
3
3
|
"siteDescription": "Beautiful documentation with the least effort possible",
|
|
4
4
|
"docsDir": "docs",
|
|
5
5
|
"outputDir": "html",
|
|
@@ -35,6 +35,10 @@ module.exports = {
|
|
|
35
35
|
{
|
|
36
36
|
"name": "google-site-verification",
|
|
37
37
|
"content": "FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "msvalidate.01",
|
|
41
|
+
"content": "B2D8C4C12C530D47AA962B24CAA09630"
|
|
38
42
|
}
|
|
39
43
|
]
|
|
40
44
|
}
|
package/html/README.html
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<meta name="description" content="<div align="center">">
|
|
7
|
-
<title>@knowcode/doc-builder |
|
|
7
|
+
<title>@knowcode/doc-builder | @knowcode/doc-builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
10
|
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, width, table">
|
|
@@ -14,22 +14,23 @@
|
|
|
14
14
|
<!-- Open Graph / Facebook -->
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/README.html">
|
|
17
|
-
<meta property="og:title" content="@knowcode/doc-builder |
|
|
17
|
+
<meta property="og:title" content="@knowcode/doc-builder | @knowcode/doc-builder">
|
|
18
18
|
<meta property="og:description" content="<div align="center">">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
-
<meta property="og:site_name" content="
|
|
20
|
+
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
22
22
|
|
|
23
23
|
<!-- Twitter Card -->
|
|
24
24
|
<meta name="twitter:card" content="summary_large_image">
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="@knowcode/doc-builder |
|
|
27
|
+
<meta name="twitter:title" content="@knowcode/doc-builder | @knowcode/doc-builder">
|
|
28
28
|
<meta name="twitter:description" content="<div align="center">">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
32
32
|
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
33
34
|
|
|
34
35
|
<!-- Fonts -->
|
|
35
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">
|
|
@@ -62,8 +63,8 @@
|
|
|
62
63
|
"name": "Knowcode Ltd",
|
|
63
64
|
"url": "https://knowcode.tech"
|
|
64
65
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-22T21:00:00.449Z",
|
|
67
|
+
"dateModified": "2025-07-22T21:00:00.449Z",
|
|
67
68
|
"mainEntityOfPage": {
|
|
68
69
|
"@type": "WebPage",
|
|
69
70
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -74,7 +75,7 @@
|
|
|
74
75
|
{
|
|
75
76
|
"@type": "ListItem",
|
|
76
77
|
"position": 1,
|
|
77
|
-
"name": "
|
|
78
|
+
"name": "@knowcode/doc-builder",
|
|
78
79
|
"item": "https://doc-builder-delta.vercel.app"
|
|
79
80
|
},
|
|
80
81
|
{
|
|
@@ -92,11 +93,11 @@
|
|
|
92
93
|
<!-- Header -->
|
|
93
94
|
<header class="header">
|
|
94
95
|
<div class="header-content">
|
|
95
|
-
<a href="/index.html" class="logo"
|
|
96
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
96
97
|
|
|
97
98
|
<div class="header-actions">
|
|
98
99
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.23">Last updated: Jul 22, 2025, 09:00 PM UTC</span>
|
|
100
101
|
</div>
|
|
101
102
|
|
|
102
103
|
|
|
@@ -148,7 +149,7 @@
|
|
|
148
149
|
<a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
149
150
|
<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>
|
|
150
151
|
<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="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
151
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the
|
|
152
|
+
<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="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
152
153
|
<div class="nav-section" data-level="1">
|
|
153
154
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
154
155
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -157,8 +158,8 @@
|
|
|
157
158
|
<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>
|
|
158
159
|
<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>
|
|
159
160
|
<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>
|
|
160
|
-
<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>
|
|
161
161
|
<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>
|
|
162
|
+
<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>
|
|
162
163
|
<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
164
|
<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>
|
|
164
165
|
<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>
|
|
@@ -280,29 +281,35 @@
|
|
|
280
281
|
</table>
|
|
281
282
|
|
|
282
283
|
<h2><i class="ph ph-gear" aria-label="settings"></i> Configuration</h2>
|
|
284
|
+
<p>Configuration is fully managed through the CLI tools - no manual file editing required! The tool handles all settings automatically during setup and deployment.</p>
|
|
283
285
|
<table>
|
|
284
286
|
<tr>
|
|
285
287
|
<td width="50%">
|
|
286
288
|
|
|
287
|
-
<h3>Basic Config</h3>
|
|
288
|
-
<pre><code class="language-javascript"
|
|
289
|
-
|
|
290
|
-
|
|
289
|
+
<h3>Basic Config (Reference Only)</h3>
|
|
290
|
+
<pre><code class="language-javascript">// doc-builder.config.js
|
|
291
|
+
// This file is auto-generated and managed by the CLI
|
|
292
|
+
module.exports = {
|
|
293
|
+
siteName: '@knowcode/doc-builder',
|
|
294
|
+
siteDescription: 'Transform markdown into beautiful documentation',
|
|
291
295
|
docsDir: 'docs',
|
|
292
296
|
outputDir: 'html'
|
|
293
297
|
};
|
|
294
298
|
</code></pre>
|
|
299
|
+
<p><em>The CLI creates and updates this for you</em></p>
|
|
295
300
|
</td>
|
|
296
301
|
<td width="50%">
|
|
297
302
|
|
|
298
|
-
<h3>Advanced Features</h3>
|
|
299
|
-
<pre><code class="language-javascript"
|
|
303
|
+
<h3>Advanced Features (Reference Only)</h3>
|
|
304
|
+
<pre><code class="language-javascript">// Also managed via CLI commands
|
|
305
|
+
features: {
|
|
300
306
|
mermaid: true, // Diagrams
|
|
301
307
|
darkMode: true, // Theme toggle
|
|
302
308
|
authentication: true, // Password
|
|
303
309
|
changelog: true // Auto-generate
|
|
304
310
|
}
|
|
305
311
|
</code></pre>
|
|
312
|
+
<p><em>Use <code>init</code> or <code>deploy</code> commands to configure</em></p>
|
|
306
313
|
</td>
|
|
307
314
|
</tr>
|
|
308
315
|
</table>
|
|
@@ -330,7 +337,7 @@
|
|
|
330
337
|
const docBuilder = require('@knowcode/doc-builder');
|
|
331
338
|
|
|
332
339
|
docBuilder.build({
|
|
333
|
-
siteName: '
|
|
340
|
+
siteName: '@knowcode/doc-builder',
|
|
334
341
|
features: { darkMode: true }
|
|
335
342
|
});
|
|
336
343
|
</code></pre>
|
|
@@ -1061,13 +1061,13 @@ tr:hover {
|
|
|
1061
1061
|
padding: var(--space-4);
|
|
1062
1062
|
border-radius: var(--radius-lg);
|
|
1063
1063
|
overflow-x: auto;
|
|
1064
|
-
margin: var(--space-
|
|
1064
|
+
margin: var(--space-2) 0;
|
|
1065
1065
|
}
|
|
1066
1066
|
|
|
1067
1067
|
/* Mermaid Full Screen Viewer */
|
|
1068
1068
|
.mermaid-container {
|
|
1069
1069
|
position: relative;
|
|
1070
|
-
margin: var(--space-
|
|
1070
|
+
margin: var(--space-3) 0;
|
|
1071
1071
|
border: 1px solid var(--color-border-default);
|
|
1072
1072
|
border-radius: var(--radius-lg);
|
|
1073
1073
|
overflow: hidden;
|
|
@@ -1129,7 +1129,7 @@ tr:hover {
|
|
|
1129
1129
|
}
|
|
1130
1130
|
|
|
1131
1131
|
.mermaid-wrapper {
|
|
1132
|
-
padding: var(--space-
|
|
1132
|
+
padding: var(--space-3);
|
|
1133
1133
|
overflow: auto;
|
|
1134
1134
|
max-height: 600px;
|
|
1135
1135
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<meta name="description" content="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.">
|
|
7
|
-
<title>Documentation Index |
|
|
7
|
+
<title>Documentation Index | @knowcode/doc-builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
10
|
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, guide, claude">
|
|
@@ -14,22 +14,23 @@
|
|
|
14
14
|
<!-- Open Graph / Facebook -->
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/documentation-index.html">
|
|
17
|
-
<meta property="og:title" content="Documentation Index |
|
|
17
|
+
<meta property="og:title" content="Documentation Index | @knowcode/doc-builder">
|
|
18
18
|
<meta property="og:description" content="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
-
<meta property="og:site_name" content="
|
|
20
|
+
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
22
22
|
|
|
23
23
|
<!-- Twitter Card -->
|
|
24
24
|
<meta name="twitter:card" content="summary_large_image">
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Documentation Index |
|
|
27
|
+
<meta name="twitter:title" content="Documentation Index | @knowcode/doc-builder">
|
|
28
28
|
<meta name="twitter:description" content="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
32
32
|
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
33
34
|
|
|
34
35
|
<!-- Fonts -->
|
|
35
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">
|
|
@@ -62,8 +63,8 @@
|
|
|
62
63
|
"name": "Knowcode Ltd",
|
|
63
64
|
"url": "https://knowcode.tech"
|
|
64
65
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-22T21:00:00.462Z",
|
|
67
|
+
"dateModified": "2025-07-22T21:00:00.462Z",
|
|
67
68
|
"mainEntityOfPage": {
|
|
68
69
|
"@type": "WebPage",
|
|
69
70
|
"@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
|
|
@@ -74,7 +75,7 @@
|
|
|
74
75
|
{
|
|
75
76
|
"@type": "ListItem",
|
|
76
77
|
"position": 1,
|
|
77
|
-
"name": "
|
|
78
|
+
"name": "@knowcode/doc-builder",
|
|
78
79
|
"item": "https://doc-builder-delta.vercel.app"
|
|
79
80
|
},
|
|
80
81
|
{
|
|
@@ -92,11 +93,11 @@
|
|
|
92
93
|
<!-- Header -->
|
|
93
94
|
<header class="header">
|
|
94
95
|
<div class="header-content">
|
|
95
|
-
<a href="/index.html" class="logo"
|
|
96
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
96
97
|
|
|
97
98
|
<div class="header-actions">
|
|
98
99
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.23">Last updated: Jul 22, 2025, 09:00 PM UTC</span>
|
|
100
101
|
</div>
|
|
101
102
|
|
|
102
103
|
|
|
@@ -148,7 +149,7 @@
|
|
|
148
149
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
149
150
|
<a href="/documentation-index.html" class="nav-item active" 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>
|
|
150
151
|
<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="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
151
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the
|
|
152
|
+
<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="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
152
153
|
<div class="nav-section" data-level="1">
|
|
153
154
|
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
154
155
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -157,8 +158,8 @@
|
|
|
157
158
|
<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>
|
|
158
159
|
<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>
|
|
159
160
|
<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>
|
|
160
|
-
<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>
|
|
161
161
|
<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>
|
|
162
|
+
<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>
|
|
162
163
|
<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
164
|
<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>
|
|
164
165
|
<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>
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<meta name="description" content="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic...">
|
|
7
|
-
<title>Authentication Guide for @knowcode/doc-builder
|
|
7
|
+
<title>Authentication Guide for @knowcode/doc-builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
10
|
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, authentication, login">
|
|
@@ -14,22 +14,23 @@
|
|
|
14
14
|
<!-- Open Graph / Facebook -->
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/authentication-guide.html">
|
|
17
|
-
<meta property="og:title" content="Authentication Guide for @knowcode/doc-builder
|
|
17
|
+
<meta property="og:title" content="Authentication Guide for @knowcode/doc-builder">
|
|
18
18
|
<meta property="og:description" content="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic...">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
-
<meta property="og:site_name" content="
|
|
20
|
+
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
22
22
|
|
|
23
23
|
<!-- Twitter Card -->
|
|
24
24
|
<meta name="twitter:card" content="summary_large_image">
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Authentication Guide for @knowcode/doc-builder
|
|
27
|
+
<meta name="twitter:title" content="Authentication Guide for @knowcode/doc-builder">
|
|
28
28
|
<meta name="twitter:description" content="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic...">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
32
32
|
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
33
34
|
|
|
34
35
|
<!-- Fonts -->
|
|
35
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">
|
|
@@ -62,8 +63,8 @@
|
|
|
62
63
|
"name": "Knowcode Ltd",
|
|
63
64
|
"url": "https://knowcode.tech"
|
|
64
65
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-22T21:00:00.465Z",
|
|
67
|
+
"dateModified": "2025-07-22T21:00:00.465Z",
|
|
67
68
|
"mainEntityOfPage": {
|
|
68
69
|
"@type": "WebPage",
|
|
69
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
|
|
@@ -74,7 +75,7 @@
|
|
|
74
75
|
{
|
|
75
76
|
"@type": "ListItem",
|
|
76
77
|
"position": 1,
|
|
77
|
-
"name": "
|
|
78
|
+
"name": "@knowcode/doc-builder",
|
|
78
79
|
"item": "https://doc-builder-delta.vercel.app"
|
|
79
80
|
},
|
|
80
81
|
{
|
|
@@ -98,11 +99,11 @@
|
|
|
98
99
|
<!-- Header -->
|
|
99
100
|
<header class="header">
|
|
100
101
|
<div class="header-content">
|
|
101
|
-
<a href="/index.html" class="logo"
|
|
102
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
102
103
|
|
|
103
104
|
<div class="header-actions">
|
|
104
105
|
<div class="deployment-info">
|
|
105
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.23">Last updated: Jul 22, 2025, 09:00 PM UTC</span>
|
|
106
107
|
</div>
|
|
107
108
|
|
|
108
109
|
|
|
@@ -154,7 +155,7 @@
|
|
|
154
155
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
155
156
|
<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>
|
|
156
157
|
<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="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
157
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the
|
|
158
|
+
<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="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
158
159
|
<div class="nav-section" data-level="1">
|
|
159
160
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
160
161
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -163,8 +164,8 @@
|
|
|
163
164
|
<a href="/guides/authentication-guide.html" class="nav-item active" 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>
|
|
164
165
|
<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>
|
|
165
166
|
<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>
|
|
166
|
-
<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>
|
|
167
167
|
<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>
|
|
168
|
+
<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>
|
|
168
169
|
<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>
|
|
169
170
|
<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>
|
|
170
171
|
<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>
|
|
@@ -237,7 +238,7 @@
|
|
|
237
238
|
<h4>1. Configuration File</h4>
|
|
238
239
|
<p>Create <code>doc-builder.config.js</code> in your project root:</p>
|
|
239
240
|
<pre><code class="language-javascript">module.exports = {
|
|
240
|
-
siteName: '
|
|
241
|
+
siteName: '@knowcode/doc-builder',
|
|
241
242
|
siteDescription: 'Internal documentation portal',
|
|
242
243
|
|
|
243
244
|
features: {
|
|
@@ -403,7 +404,7 @@
|
|
|
403
404
|
<h3>Simple Protected Docs</h3>
|
|
404
405
|
<pre><code class="language-javascript">// doc-builder.config.js
|
|
405
406
|
module.exports = {
|
|
406
|
-
siteName: '
|
|
407
|
+
siteName: '@knowcode/doc-builder',
|
|
407
408
|
features: {
|
|
408
409
|
authentication: true
|
|
409
410
|
},
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<meta property="og:title" content="Claude + CLAUDE.md Documentation Workflow Guide">
|
|
18
18
|
<meta property="og:description" content="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it to...">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
-
<meta property="og:site_name" content="
|
|
20
|
+
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
22
22
|
|
|
23
23
|
<!-- Twitter Card -->
|
|
@@ -30,6 +30,7 @@
|
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
32
32
|
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
+
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
33
34
|
|
|
34
35
|
<!-- Fonts -->
|
|
35
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">
|
|
@@ -62,8 +63,8 @@
|
|
|
62
63
|
"name": "Knowcode Ltd",
|
|
63
64
|
"url": "https://knowcode.tech"
|
|
64
65
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-22T21:00:00.479Z",
|
|
67
|
+
"dateModified": "2025-07-22T21:00:00.479Z",
|
|
67
68
|
"mainEntityOfPage": {
|
|
68
69
|
"@type": "WebPage",
|
|
69
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html"
|
|
@@ -74,7 +75,7 @@
|
|
|
74
75
|
{
|
|
75
76
|
"@type": "ListItem",
|
|
76
77
|
"position": 1,
|
|
77
|
-
"name": "
|
|
78
|
+
"name": "@knowcode/doc-builder",
|
|
78
79
|
"item": "https://doc-builder-delta.vercel.app"
|
|
79
80
|
},
|
|
80
81
|
{
|
|
@@ -98,11 +99,11 @@
|
|
|
98
99
|
<!-- Header -->
|
|
99
100
|
<header class="header">
|
|
100
101
|
<div class="header-content">
|
|
101
|
-
<a href="/index.html" class="logo"
|
|
102
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
102
103
|
|
|
103
104
|
<div class="header-actions">
|
|
104
105
|
<div class="deployment-info">
|
|
105
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.23">Last updated: Jul 22, 2025, 09:00 PM UTC</span>
|
|
106
107
|
</div>
|
|
107
108
|
|
|
108
109
|
|
|
@@ -154,7 +155,7 @@
|
|
|
154
155
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
155
156
|
<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>
|
|
156
157
|
<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="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
157
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the
|
|
158
|
+
<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="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
158
159
|
<div class="nav-section" data-level="1">
|
|
159
160
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
160
161
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -163,8 +164,8 @@
|
|
|
163
164
|
<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>
|
|
164
165
|
<a href="/guides/claude-workflow-guide.html" class="nav-item active" 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>
|
|
165
166
|
<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>
|
|
166
|
-
<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>
|
|
167
167
|
<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>
|
|
168
|
+
<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>
|
|
168
169
|
<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>
|
|
169
170
|
<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>
|
|
170
171
|
<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>
|