@knowcode/doc-builder 1.9.0 → 1.9.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 +2 -0
- package/html/README.html +34 -149
- package/html/css/notion-style.css +13 -394
- package/html/documentation-index.html +17 -127
- package/html/guides/authentication-default-change.html +8 -130
- package/html/guides/authentication-guide.html +20 -141
- package/html/guides/claude-workflow-guide.html +23 -137
- package/html/guides/documentation-standards.html +12 -133
- package/html/guides/image-modal-guide.html +381 -0
- package/html/guides/phosphor-icons-guide.html +28 -150
- package/html/guides/private-directory-authentication.html +8 -130
- package/html/guides/public-site-deployment.html +8 -130
- package/html/guides/search-engine-verification-guide.html +8 -130
- package/html/guides/seo-guide.html +8 -130
- package/html/guides/seo-optimization-guide.html +39 -159
- package/html/guides/troubleshooting-guide.html +20 -141
- package/html/guides/windows-setup-guide.html +39 -161
- package/html/image-modal-test.html +9 -125
- package/html/index.html +34 -149
- package/html/js/auth.js +39 -118
- package/html/js/main.js +25 -259
- package/html/private/cache-control-anti-pattern.html +13 -135
- package/html/private/launch/README.html +16 -144
- package/html/private/launch/auth-cleanup-summary.html +25 -153
- package/html/private/launch/bubble-plugin-specification.html +8 -136
- package/html/private/launch/go-to-market-strategy.html +10 -138
- package/html/private/launch/launch-announcements.html +24 -151
- package/html/private/launch/vercel-deployment-auth-setup.html +10 -138
- package/html/private/next-steps-walkthrough.html +15 -137
- package/html/private/supabase-auth-implementation-completed.html +22 -143
- package/html/private/supabase-auth-implementation-plan.html +15 -136
- package/html/private/supabase-auth-integration-plan.html +22 -142
- package/html/private/supabase-auth-setup-guide.html +17 -139
- package/html/private/test-private-doc.html +8 -130
- package/html/private/user-management-tooling.html +8 -130
- package/html/prompts/markdown-document-standards.html +13 -134
- package/html/vercel-cli-setup-guide.html +12 -128
- package/html/vercel-first-time-setup-guide.html +9 -125
- package/lib/emoji-mapper.js +12 -0
- package/package.json +1 -1
|
@@ -3,41 +3,14 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>Phosphor Icons Integration Guide
|
|
8
|
-
|
|
9
|
-
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, icon, icons">
|
|
11
|
-
<meta name="robots" content="index, follow">
|
|
12
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/phosphor-icons-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/phosphor-icons-guide.html">
|
|
17
|
-
<meta property="og:title" content="Phosphor Icons Integration Guide | @knowcode/doc-builder">
|
|
18
|
-
<meta property="og:description" content="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML. This provides...">
|
|
19
|
-
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
-
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
21
|
-
<meta property="og:locale" content="en_US">
|
|
22
|
-
|
|
23
|
-
<!-- Twitter Card -->
|
|
24
|
-
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
-
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
-
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Phosphor Icons Integration Guide | @knowcode/doc-builder">
|
|
28
|
-
<meta name="twitter:description" content="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML. This provides...">
|
|
29
|
-
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
|
-
|
|
31
|
-
<!-- Custom Meta Tags -->
|
|
32
|
-
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
-
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
6
|
+
<meta name="description" content="Beautiful documentation with the least effort possible">
|
|
7
|
+
<title>Phosphor Icons Integration Guide - @knowcode/doc-builder</title>
|
|
34
8
|
|
|
35
9
|
<!-- Fonts -->
|
|
36
10
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
37
11
|
|
|
38
12
|
<!-- Icons -->
|
|
39
13
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
40
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
41
14
|
|
|
42
15
|
<!-- Mermaid -->
|
|
43
16
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -45,90 +18,8 @@
|
|
|
45
18
|
<!-- Styles -->
|
|
46
19
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
47
20
|
|
|
48
|
-
|
|
49
|
-
<!-- Hide content until auth check -->
|
|
50
|
-
<style>
|
|
51
|
-
body {
|
|
52
|
-
visibility: hidden;
|
|
53
|
-
opacity: 0;
|
|
54
|
-
transition: opacity 0.3s ease;
|
|
55
|
-
}
|
|
56
|
-
body.authenticated {
|
|
57
|
-
visibility: visible;
|
|
58
|
-
opacity: 1;
|
|
59
|
-
}
|
|
60
|
-
/* Show login/logout pages immediately */
|
|
61
|
-
body.auth-page {
|
|
62
|
-
visibility: visible;
|
|
63
|
-
opacity: 1;
|
|
64
|
-
}
|
|
65
|
-
/* Style auth button consistently */
|
|
66
|
-
.auth-btn {
|
|
67
|
-
background: none;
|
|
68
|
-
border: none;
|
|
69
|
-
color: var(--text-secondary);
|
|
70
|
-
cursor: pointer;
|
|
71
|
-
padding: 0.5rem;
|
|
72
|
-
border-radius: 0.5rem;
|
|
73
|
-
transition: all 0.2s;
|
|
74
|
-
font-size: 1.1rem;
|
|
75
|
-
}
|
|
76
|
-
.auth-btn:hover {
|
|
77
|
-
background: var(--bg-secondary);
|
|
78
|
-
color: var(--text-primary);
|
|
79
|
-
}
|
|
80
|
-
</style>
|
|
81
|
-
|
|
82
|
-
|
|
83
21
|
<!-- Favicon -->
|
|
84
|
-
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22
|
|
85
|
-
|
|
86
|
-
<script type="application/ld+json">
|
|
87
|
-
{
|
|
88
|
-
"@context": "https://schema.org",
|
|
89
|
-
"@type": "TechArticle",
|
|
90
|
-
"headline": "Phosphor Icons Integration Guide",
|
|
91
|
-
"description": "@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML. This provides...",
|
|
92
|
-
"author": {
|
|
93
|
-
"@type": "Person",
|
|
94
|
-
"name": "Lindsay Smith"
|
|
95
|
-
},
|
|
96
|
-
"publisher": {
|
|
97
|
-
"@type": "Organization",
|
|
98
|
-
"name": "Knowcode Ltd",
|
|
99
|
-
"url": "https://knowcode.tech"
|
|
100
|
-
},
|
|
101
|
-
"datePublished": "2025-07-27T08:30:10.781Z",
|
|
102
|
-
"dateModified": "2025-07-27T08:30:10.781Z",
|
|
103
|
-
"mainEntityOfPage": {
|
|
104
|
-
"@type": "WebPage",
|
|
105
|
-
"@id": "https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html"
|
|
106
|
-
},
|
|
107
|
-
"breadcrumb": {
|
|
108
|
-
"@type": "BreadcrumbList",
|
|
109
|
-
"itemListElement": [
|
|
110
|
-
{
|
|
111
|
-
"@type": "ListItem",
|
|
112
|
-
"position": 1,
|
|
113
|
-
"name": "@knowcode/doc-builder",
|
|
114
|
-
"item": "https://doc-builder-delta.vercel.app"
|
|
115
|
-
},
|
|
116
|
-
{
|
|
117
|
-
"@type": "ListItem",
|
|
118
|
-
"position": 2,
|
|
119
|
-
"name": "Guides",
|
|
120
|
-
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
121
|
-
},
|
|
122
|
-
{
|
|
123
|
-
"@type": "ListItem",
|
|
124
|
-
"position": 3,
|
|
125
|
-
"name": "Phosphor Icons Guide",
|
|
126
|
-
"item": "https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html"
|
|
127
|
-
}
|
|
128
|
-
]
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
</script>
|
|
22
|
+
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
132
23
|
</head>
|
|
133
24
|
<body>
|
|
134
25
|
<!-- Header -->
|
|
@@ -138,14 +29,10 @@
|
|
|
138
29
|
|
|
139
30
|
<div class="header-actions">
|
|
140
31
|
<div class="deployment-info">
|
|
141
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
|
|
142
33
|
</div>
|
|
143
34
|
|
|
144
35
|
|
|
145
|
-
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
-
</a>
|
|
148
|
-
|
|
149
36
|
|
|
150
37
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
151
38
|
<i class="fas fa-moon"></i>
|
|
@@ -205,6 +92,7 @@
|
|
|
205
92
|
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
206
93
|
<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>
|
|
207
94
|
<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>
|
|
95
|
+
<a href="/guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="fas fa-file-alt"></i> Image Modal Guide</a>
|
|
208
96
|
<a href="/guides/phosphor-icons-guide.html" class="nav-item active" 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>
|
|
209
97
|
<a href="/guides/private-directory-authentication.html" class="nav-item" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="fas fa-file-alt"></i> Private Directory Authentication</a>
|
|
210
98
|
<a href="/guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="fas fa-file-alt"></i> Public Site Deployment</a>
|
|
@@ -213,7 +101,7 @@
|
|
|
213
101
|
<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>
|
|
214
102
|
<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>
|
|
215
103
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
216
|
-
<div class="nav-section
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
217
105
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
218
106
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
219
107
|
</a>
|
|
@@ -226,7 +114,7 @@
|
|
|
226
114
|
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
227
115
|
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
|
|
228
116
|
<a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
229
|
-
<div class="nav-section
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
230
118
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
231
119
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
232
120
|
</a>
|
|
@@ -262,9 +150,9 @@
|
|
|
262
150
|
</code></pre>
|
|
263
151
|
<p>They are automatically converted to Phosphor icons in HTML:</p>
|
|
264
152
|
<ul>
|
|
265
|
-
<li
|
|
266
|
-
<li
|
|
267
|
-
<li
|
|
153
|
+
<li>✅ → Check circle icon</li>
|
|
154
|
+
<li>❌ → X circle icon </li>
|
|
155
|
+
<li>🚀 → Rocket launch icon</li>
|
|
268
156
|
</ul>
|
|
269
157
|
<h3>Benefits</h3>
|
|
270
158
|
<ul>
|
|
@@ -305,27 +193,27 @@
|
|
|
305
193
|
</tr>
|
|
306
194
|
</thead>
|
|
307
195
|
<tbody><tr>
|
|
308
|
-
<td
|
|
196
|
+
<td>✅</td>
|
|
309
197
|
<td>Check circle</td>
|
|
310
198
|
<td>Success, completed, verified</td>
|
|
311
199
|
</tr>
|
|
312
200
|
<tr>
|
|
313
|
-
<td
|
|
201
|
+
<td>❌</td>
|
|
314
202
|
<td>X circle</td>
|
|
315
203
|
<td>Error, failed, incorrect</td>
|
|
316
204
|
</tr>
|
|
317
205
|
<tr>
|
|
318
|
-
<td
|
|
206
|
+
<td>❓</td>
|
|
319
207
|
<td>Question mark</td>
|
|
320
208
|
<td>Unknown, uncertain</td>
|
|
321
209
|
</tr>
|
|
322
210
|
<tr>
|
|
323
|
-
<td
|
|
211
|
+
<td>⚠️</td>
|
|
324
212
|
<td>Warning circle</td>
|
|
325
213
|
<td>Caution, important note</td>
|
|
326
214
|
</tr>
|
|
327
215
|
<tr>
|
|
328
|
-
<td
|
|
216
|
+
<td>🚫</td>
|
|
329
217
|
<td>Prohibit</td>
|
|
330
218
|
<td>Not allowed, forbidden</td>
|
|
331
219
|
</tr>
|
|
@@ -340,27 +228,27 @@
|
|
|
340
228
|
</tr>
|
|
341
229
|
</thead>
|
|
342
230
|
<tbody><tr>
|
|
343
|
-
<td
|
|
231
|
+
<td>💻</td>
|
|
344
232
|
<td>Laptop</td>
|
|
345
233
|
<td>Development, coding</td>
|
|
346
234
|
</tr>
|
|
347
235
|
<tr>
|
|
348
|
-
<td
|
|
236
|
+
<td>🔧</td>
|
|
349
237
|
<td>Wrench</td>
|
|
350
238
|
<td>Configuration, settings</td>
|
|
351
239
|
</tr>
|
|
352
240
|
<tr>
|
|
353
|
-
<td
|
|
241
|
+
<td>🐛</td>
|
|
354
242
|
<td>Bug</td>
|
|
355
243
|
<td>Issues, debugging</td>
|
|
356
244
|
</tr>
|
|
357
245
|
<tr>
|
|
358
|
-
<td
|
|
246
|
+
<td>🚀</td>
|
|
359
247
|
<td>Rocket</td>
|
|
360
248
|
<td>Launch, deploy, release</td>
|
|
361
249
|
</tr>
|
|
362
250
|
<tr>
|
|
363
|
-
<td
|
|
251
|
+
<td>⚡</td>
|
|
364
252
|
<td>Lightning</td>
|
|
365
253
|
<td>Performance, speed</td>
|
|
366
254
|
</tr>
|
|
@@ -375,22 +263,22 @@
|
|
|
375
263
|
</tr>
|
|
376
264
|
</thead>
|
|
377
265
|
<tbody><tr>
|
|
378
|
-
<td
|
|
266
|
+
<td>📝</td>
|
|
379
267
|
<td>Note pencil</td>
|
|
380
268
|
<td>Edit, write</td>
|
|
381
269
|
</tr>
|
|
382
270
|
<tr>
|
|
383
|
-
<td
|
|
271
|
+
<td>📚</td>
|
|
384
272
|
<td>Books</td>
|
|
385
273
|
<td>Documentation, guides</td>
|
|
386
274
|
</tr>
|
|
387
275
|
<tr>
|
|
388
|
-
<td
|
|
276
|
+
<td>📁</td>
|
|
389
277
|
<td>Folder</td>
|
|
390
278
|
<td>Directory, category</td>
|
|
391
279
|
</tr>
|
|
392
280
|
<tr>
|
|
393
|
-
<td
|
|
281
|
+
<td>🔗</td>
|
|
394
282
|
<td>Link</td>
|
|
395
283
|
<td>URL, connection</td>
|
|
396
284
|
</tr>
|
|
@@ -405,17 +293,17 @@
|
|
|
405
293
|
</tr>
|
|
406
294
|
</thead>
|
|
407
295
|
<tbody><tr>
|
|
408
|
-
<td
|
|
296
|
+
<td>💬</td>
|
|
409
297
|
<td>Chat circle</td>
|
|
410
298
|
<td>Comments, discussion</td>
|
|
411
299
|
</tr>
|
|
412
300
|
<tr>
|
|
413
|
-
<td
|
|
301
|
+
<td>📧</td>
|
|
414
302
|
<td>Envelope</td>
|
|
415
303
|
<td>Email, message</td>
|
|
416
304
|
</tr>
|
|
417
305
|
<tr>
|
|
418
|
-
<td
|
|
306
|
+
<td>🔔</td>
|
|
419
307
|
<td>Bell</td>
|
|
420
308
|
<td>Notification, alert</td>
|
|
421
309
|
</tr>
|
|
@@ -555,17 +443,7 @@
|
|
|
555
443
|
</div>
|
|
556
444
|
|
|
557
445
|
<!-- Scripts -->
|
|
558
|
-
<script>
|
|
559
|
-
// Pass configuration to frontend
|
|
560
|
-
window.docBuilderConfig = {
|
|
561
|
-
features: {
|
|
562
|
-
showPdfDownload: true,
|
|
563
|
-
menuDefaultOpen: false
|
|
564
|
-
}
|
|
565
|
-
};
|
|
566
|
-
</script>
|
|
567
446
|
<script src="/js/main.js"></script>
|
|
568
|
-
|
|
569
|
-
<script src="/js/auth.js"></script>
|
|
447
|
+
|
|
570
448
|
</body>
|
|
571
449
|
</html>
|
|
@@ -3,41 +3,14 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>Private Directory Authentication Guide</title>
|
|
8
|
-
|
|
9
|
-
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, private, authentication">
|
|
11
|
-
<meta name="robots" content="index, follow">
|
|
12
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/private-directory-authentication.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/private-directory-authentication.html">
|
|
17
|
-
<meta property="og:title" content="Private Directory Authentication Guide">
|
|
18
|
-
<meta property="og:description" content="The @knowcode/doc-builder provides flexible authentication options to protect your documentation. You can either protect specific documents using a `private`...">
|
|
19
|
-
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
-
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
21
|
-
<meta property="og:locale" content="en_US">
|
|
22
|
-
|
|
23
|
-
<!-- Twitter Card -->
|
|
24
|
-
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
-
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
-
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Private Directory Authentication Guide">
|
|
28
|
-
<meta name="twitter:description" content="The @knowcode/doc-builder provides flexible authentication options to protect your documentation. You can either protect specific documents using a `private`...">
|
|
29
|
-
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
|
-
|
|
31
|
-
<!-- Custom Meta Tags -->
|
|
32
|
-
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
-
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
6
|
+
<meta name="description" content="Beautiful documentation with the least effort possible">
|
|
7
|
+
<title>Private Directory Authentication Guide - @knowcode/doc-builder</title>
|
|
34
8
|
|
|
35
9
|
<!-- Fonts -->
|
|
36
10
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
37
11
|
|
|
38
12
|
<!-- Icons -->
|
|
39
13
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
40
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
41
14
|
|
|
42
15
|
<!-- Mermaid -->
|
|
43
16
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -45,90 +18,8 @@
|
|
|
45
18
|
<!-- Styles -->
|
|
46
19
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
47
20
|
|
|
48
|
-
|
|
49
|
-
<!-- Hide content until auth check -->
|
|
50
|
-
<style>
|
|
51
|
-
body {
|
|
52
|
-
visibility: hidden;
|
|
53
|
-
opacity: 0;
|
|
54
|
-
transition: opacity 0.3s ease;
|
|
55
|
-
}
|
|
56
|
-
body.authenticated {
|
|
57
|
-
visibility: visible;
|
|
58
|
-
opacity: 1;
|
|
59
|
-
}
|
|
60
|
-
/* Show login/logout pages immediately */
|
|
61
|
-
body.auth-page {
|
|
62
|
-
visibility: visible;
|
|
63
|
-
opacity: 1;
|
|
64
|
-
}
|
|
65
|
-
/* Style auth button consistently */
|
|
66
|
-
.auth-btn {
|
|
67
|
-
background: none;
|
|
68
|
-
border: none;
|
|
69
|
-
color: var(--text-secondary);
|
|
70
|
-
cursor: pointer;
|
|
71
|
-
padding: 0.5rem;
|
|
72
|
-
border-radius: 0.5rem;
|
|
73
|
-
transition: all 0.2s;
|
|
74
|
-
font-size: 1.1rem;
|
|
75
|
-
}
|
|
76
|
-
.auth-btn:hover {
|
|
77
|
-
background: var(--bg-secondary);
|
|
78
|
-
color: var(--text-primary);
|
|
79
|
-
}
|
|
80
|
-
</style>
|
|
81
|
-
|
|
82
|
-
|
|
83
21
|
<!-- Favicon -->
|
|
84
|
-
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22
|
|
85
|
-
|
|
86
|
-
<script type="application/ld+json">
|
|
87
|
-
{
|
|
88
|
-
"@context": "https://schema.org",
|
|
89
|
-
"@type": "TechArticle",
|
|
90
|
-
"headline": "Private Directory Authentication Guide",
|
|
91
|
-
"description": "The @knowcode/doc-builder provides flexible authentication options to protect your documentation. You can either protect specific documents using a `private`...",
|
|
92
|
-
"author": {
|
|
93
|
-
"@type": "Person",
|
|
94
|
-
"name": "Lindsay Smith"
|
|
95
|
-
},
|
|
96
|
-
"publisher": {
|
|
97
|
-
"@type": "Organization",
|
|
98
|
-
"name": "Knowcode Ltd",
|
|
99
|
-
"url": "https://knowcode.tech"
|
|
100
|
-
},
|
|
101
|
-
"datePublished": "2025-07-27T08:30:10.783Z",
|
|
102
|
-
"dateModified": "2025-07-27T08:30:10.783Z",
|
|
103
|
-
"mainEntityOfPage": {
|
|
104
|
-
"@type": "WebPage",
|
|
105
|
-
"@id": "https://doc-builder-delta.vercel.app/guides/private-directory-authentication.html"
|
|
106
|
-
},
|
|
107
|
-
"breadcrumb": {
|
|
108
|
-
"@type": "BreadcrumbList",
|
|
109
|
-
"itemListElement": [
|
|
110
|
-
{
|
|
111
|
-
"@type": "ListItem",
|
|
112
|
-
"position": 1,
|
|
113
|
-
"name": "@knowcode/doc-builder",
|
|
114
|
-
"item": "https://doc-builder-delta.vercel.app"
|
|
115
|
-
},
|
|
116
|
-
{
|
|
117
|
-
"@type": "ListItem",
|
|
118
|
-
"position": 2,
|
|
119
|
-
"name": "Guides",
|
|
120
|
-
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
121
|
-
},
|
|
122
|
-
{
|
|
123
|
-
"@type": "ListItem",
|
|
124
|
-
"position": 3,
|
|
125
|
-
"name": "Private Directory Authentication",
|
|
126
|
-
"item": "https://doc-builder-delta.vercel.app/guides/private-directory-authentication.html"
|
|
127
|
-
}
|
|
128
|
-
]
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
</script>
|
|
22
|
+
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
|
|
132
23
|
</head>
|
|
133
24
|
<body>
|
|
134
25
|
<!-- Header -->
|
|
@@ -138,14 +29,10 @@
|
|
|
138
29
|
|
|
139
30
|
<div class="header-actions">
|
|
140
31
|
<div class="deployment-info">
|
|
141
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
|
|
142
33
|
</div>
|
|
143
34
|
|
|
144
35
|
|
|
145
|
-
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
-
</a>
|
|
148
|
-
|
|
149
36
|
|
|
150
37
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
151
38
|
<i class="fas fa-moon"></i>
|
|
@@ -205,6 +92,7 @@
|
|
|
205
92
|
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="fas fa-file-alt"></i> Authentication Guide</a>
|
|
206
93
|
<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>
|
|
207
94
|
<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>
|
|
95
|
+
<a href="/guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="fas fa-file-alt"></i> Image Modal Guide</a>
|
|
208
96
|
<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>
|
|
209
97
|
<a href="/guides/private-directory-authentication.html" class="nav-item active" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="fas fa-file-alt"></i> Private Directory Authentication</a>
|
|
210
98
|
<a href="/guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="fas fa-file-alt"></i> Public Site Deployment</a>
|
|
@@ -213,7 +101,7 @@
|
|
|
213
101
|
<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>
|
|
214
102
|
<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>
|
|
215
103
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
216
|
-
<div class="nav-section
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
217
105
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
218
106
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
219
107
|
</a>
|
|
@@ -226,7 +114,7 @@
|
|
|
226
114
|
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
227
115
|
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
|
|
228
116
|
<a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
229
|
-
<div class="nav-section
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
230
118
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
231
119
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
232
120
|
</a>
|
|
@@ -512,17 +400,7 @@ module.exports = {
|
|
|
512
400
|
</div>
|
|
513
401
|
|
|
514
402
|
<!-- Scripts -->
|
|
515
|
-
<script>
|
|
516
|
-
// Pass configuration to frontend
|
|
517
|
-
window.docBuilderConfig = {
|
|
518
|
-
features: {
|
|
519
|
-
showPdfDownload: true,
|
|
520
|
-
menuDefaultOpen: false
|
|
521
|
-
}
|
|
522
|
-
};
|
|
523
|
-
</script>
|
|
524
403
|
<script src="/js/main.js"></script>
|
|
525
|
-
|
|
526
|
-
<script src="/js/auth.js"></script>
|
|
404
|
+
|
|
527
405
|
</body>
|
|
528
406
|
</html>
|