@knowcode/doc-builder 1.5.23 → 1.6.1
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 +1 -0
- package/cli.js +73 -0
- package/doc-builder.config.js +4 -0
- package/html/README.html +15 -13
- package/html/documentation-index.html +12 -11
- package/html/guides/authentication-guide.html +12 -11
- 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 +15 -13
- 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 +23 -23
- package/html/vercel-cli-setup-guide.html +12 -11
- package/html/vercel-first-time-setup-guide.html +13 -12
- package/lib/config.js +3 -0
- package/lib/core-builder.js +13 -1
- package/lib/emoji-mapper.js +7 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -203,6 +203,7 @@ module.exports = {
|
|
|
203
203
|
// Site info
|
|
204
204
|
siteName: '@knowcode/doc-builder',
|
|
205
205
|
siteDescription: 'Transform markdown into beautiful documentation',
|
|
206
|
+
favicon: '✨', // Can be emoji or path to image file
|
|
206
207
|
|
|
207
208
|
// Production URL (optional)
|
|
208
209
|
productionUrl: 'https://my-docs.vercel.app', // Custom URL to display after deployment
|
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
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">
|
|
@@ -45,7 +46,7 @@
|
|
|
45
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
46
47
|
|
|
47
48
|
<!-- Favicon -->
|
|
48
|
-
<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
|
|
49
|
+
<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>">
|
|
49
50
|
|
|
50
51
|
<script type="application/ld+json">
|
|
51
52
|
{
|
|
@@ -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-23T06:51:04.406Z",
|
|
67
|
+
"dateModified": "2025-07-23T06:51:04.406Z",
|
|
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.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.0">Last updated: Jul 23, 2025, 06:51 AM UTC</span>
|
|
100
101
|
</div>
|
|
101
102
|
|
|
102
103
|
|
|
@@ -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>
|
|
@@ -292,7 +293,8 @@ module.exports = {
|
|
|
292
293
|
siteName: '@knowcode/doc-builder',
|
|
293
294
|
siteDescription: 'Transform markdown into beautiful documentation',
|
|
294
295
|
docsDir: 'docs',
|
|
295
|
-
outputDir: 'html'
|
|
296
|
+
outputDir: 'html',
|
|
297
|
+
favicon: '<i class="ph ph-sparkle" aria-label="special"></i>' // Can be emoji or path to image
|
|
296
298
|
};
|
|
297
299
|
</code></pre>
|
|
298
300
|
<p><em>The CLI creates and updates this for you</em></p>
|
|
@@ -400,7 +402,7 @@ docBuilder.build({
|
|
|
400
402
|
<ul>
|
|
401
403
|
<li><i class="ph ph-package" aria-label="package"></i> <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
|
|
402
404
|
<li>🐙 <a href="https://github.com/wapdat/doc-builder">GitHub Repo</a></li>
|
|
403
|
-
<li
|
|
405
|
+
<li><i class="ph ph-globe" aria-label="global"></i> <a href="https://knowcode.com">Website</a></li>
|
|
404
406
|
<li><i class="ph ph-chat-circle" aria-label="chat"></i> <a href="https://github.com/wapdat/doc-builder/discussions">Discussions</a></li>
|
|
405
407
|
</ul>
|
|
406
408
|
</td>
|
|
@@ -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">
|
|
@@ -45,7 +46,7 @@
|
|
|
45
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
46
47
|
|
|
47
48
|
<!-- Favicon -->
|
|
48
|
-
<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
|
|
49
|
+
<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>">
|
|
49
50
|
|
|
50
51
|
<script type="application/ld+json">
|
|
51
52
|
{
|
|
@@ -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-23T06:51:04.420Z",
|
|
67
|
+
"dateModified": "2025-07-23T06:51:04.420Z",
|
|
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.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.0">Last updated: Jul 23, 2025, 06:51 AM UTC</span>
|
|
100
101
|
</div>
|
|
101
102
|
|
|
102
103
|
|
|
@@ -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">
|
|
@@ -45,7 +46,7 @@
|
|
|
45
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
46
47
|
|
|
47
48
|
<!-- Favicon -->
|
|
48
|
-
<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
|
|
49
|
+
<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>">
|
|
49
50
|
|
|
50
51
|
<script type="application/ld+json">
|
|
51
52
|
{
|
|
@@ -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-23T06:51:04.424Z",
|
|
67
|
+
"dateModified": "2025-07-23T06:51:04.424Z",
|
|
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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.0">Last updated: Jul 23, 2025, 06:51 AM UTC</span>
|
|
106
107
|
</div>
|
|
107
108
|
|
|
108
109
|
|
|
@@ -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>
|
|
@@ -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">
|
|
@@ -45,7 +46,7 @@
|
|
|
45
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
46
47
|
|
|
47
48
|
<!-- Favicon -->
|
|
48
|
-
<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
|
|
49
|
+
<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>">
|
|
49
50
|
|
|
50
51
|
<script type="application/ld+json">
|
|
51
52
|
{
|
|
@@ -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-23T06:51:04.431Z",
|
|
67
|
+
"dateModified": "2025-07-23T06:51:04.431Z",
|
|
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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.0">Last updated: Jul 23, 2025, 06:51 AM UTC</span>
|
|
106
107
|
</div>
|
|
107
108
|
|
|
108
109
|
|
|
@@ -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>
|
|
@@ -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 document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project...">
|
|
7
|
-
<title>Document Standards for @knowcode/doc-builder
|
|
7
|
+
<title>Document Standards 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, document, use">
|
|
@@ -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/documentation-standards.html">
|
|
17
|
-
<meta property="og:title" content="Document Standards for @knowcode/doc-builder
|
|
17
|
+
<meta property="og:title" content="Document Standards for @knowcode/doc-builder">
|
|
18
18
|
<meta property="og:description" content="This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project...">
|
|
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="Document Standards for @knowcode/doc-builder
|
|
27
|
+
<meta name="twitter:title" content="Document Standards for @knowcode/doc-builder">
|
|
28
28
|
<meta name="twitter:description" content="This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project...">
|
|
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">
|
|
@@ -45,7 +46,7 @@
|
|
|
45
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
46
47
|
|
|
47
48
|
<!-- Favicon -->
|
|
48
|
-
<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
|
|
49
|
+
<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>">
|
|
49
50
|
|
|
50
51
|
<script type="application/ld+json">
|
|
51
52
|
{
|
|
@@ -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-23T06:51:04.440Z",
|
|
67
|
+
"dateModified": "2025-07-23T06:51:04.440Z",
|
|
67
68
|
"mainEntityOfPage": {
|
|
68
69
|
"@type": "WebPage",
|
|
69
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/documentation-standards.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.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.0">Last updated: Jul 23, 2025, 06:51 AM UTC</span>
|
|
106
107
|
</div>
|
|
107
108
|
|
|
108
109
|
|
|
@@ -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" 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 active" 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>
|