@knowcode/doc-builder 1.5.11 → 1.5.13
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/CHANGELOG.md +37 -0
- package/README.md +13 -12
- package/doc-builder.config.js +2 -1
- package/html/README.html +25 -24
- package/html/documentation-index.html +10 -9
- package/html/guides/authentication-guide.html +19 -18
- package/html/guides/claude-workflow-guide.html +24 -23
- package/html/guides/documentation-standards.html +21 -20
- package/html/guides/google-site-verification-guide.html +6 -5
- package/html/guides/seo-guide.html +10 -9
- package/html/guides/seo-optimization-guide.html +39 -38
- package/html/guides/troubleshooting-guide.html +39 -28
- package/html/index.html +25 -24
- package/html/sitemap.xml +15 -15
- package/html/vercel-cli-setup-guide.html +114 -174
- package/html/vercel-first-time-setup-guide.html +134 -217
- package/lib/config.js +8 -2
- package/lib/core-builder.js +7 -2
- package/lib/emoji-mapper.js +267 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,43 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.5.13] - 2025-07-22
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- **Phosphor Icons Integration** - Automatically convert Unicode emojis to beautiful Phosphor icons in generated HTML
|
|
12
|
+
- Comprehensive emoji-to-icon mapping with 200+ supported emojis
|
|
13
|
+
- Configurable icon weights (thin, light, regular, bold, fill, duotone)
|
|
14
|
+
- Configurable icon size relative to text
|
|
15
|
+
- Accessibility support with proper aria-labels for all icons
|
|
16
|
+
- New `phosphor-icons-guide.md` documentation
|
|
17
|
+
|
|
18
|
+
### Changed
|
|
19
|
+
- HTML template now includes Phosphor Icons CDN when feature is enabled
|
|
20
|
+
- Post-processing step to replace emojis with icon tags after markdown parsing
|
|
21
|
+
|
|
22
|
+
### Technical Details
|
|
23
|
+
- Added `lib/emoji-mapper.js` with comprehensive emoji mappings
|
|
24
|
+
- Updated `core-builder.js` to process emojis during HTML generation
|
|
25
|
+
- Added configuration options: `phosphorIcons`, `phosphorWeight`, `phosphorSize`
|
|
26
|
+
- Icons inherit text color and can be styled with CSS
|
|
27
|
+
|
|
28
|
+
## [1.5.12] - 2025-07-22
|
|
29
|
+
|
|
30
|
+
### Documentation
|
|
31
|
+
- 📚 **Updated all Vercel documentation** for the simplified setup process
|
|
32
|
+
- ✨ **Rewrote vercel-first-time-setup-guide.md** with streamlined 6-step process
|
|
33
|
+
- 🔧 **Updated vercel-cli-setup-guide.md** to focus on installation and advanced usage
|
|
34
|
+
- 📝 **Simplified README.md deployment section** to 4 clear steps
|
|
35
|
+
- 🐛 **Updated troubleshooting-guide.md** with new deployment solutions
|
|
36
|
+
- 🎯 **Removed references to complex prompts** and confusing options
|
|
37
|
+
- 📖 **Added 'What Changed' section** highlighting improvements
|
|
38
|
+
|
|
39
|
+
### Documentation Improvements
|
|
40
|
+
- No more confusing "Found project xyz/html" prompts
|
|
41
|
+
- No more root directory confusion
|
|
42
|
+
- Clear, straightforward deployment flow
|
|
43
|
+
- Better error messages and solutions
|
|
44
|
+
|
|
8
45
|
## [1.5.11] - 2025-07-22
|
|
9
46
|
|
|
10
47
|
### Fixed
|
package/README.md
CHANGED
|
@@ -86,22 +86,23 @@ doc-builder deploy
|
|
|
86
86
|
|
|
87
87
|
## First-Time Vercel Deployment
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
The deployment process is now simpler than ever:
|
|
90
90
|
|
|
91
|
-
1.
|
|
92
|
-
2.
|
|
93
|
-
3.
|
|
94
|
-
4.
|
|
95
|
-
5. Show important reminders about Vercel settings
|
|
91
|
+
1. Run `npx @knowcode/doc-builder deploy`
|
|
92
|
+
2. Answer a few simple questions (project name, etc.)
|
|
93
|
+
3. Vercel CLI automatically detects and configures everything
|
|
94
|
+
4. Get your live URL in seconds!
|
|
96
95
|
|
|
97
|
-
###
|
|
96
|
+
### Making Your Docs Public
|
|
98
97
|
|
|
99
|
-
After deployment,
|
|
98
|
+
After deployment, if you want public access:
|
|
100
99
|
|
|
101
|
-
1.
|
|
102
|
-
2.
|
|
103
|
-
3. Set to **Disabled**
|
|
104
|
-
4.
|
|
100
|
+
1. Go to [Vercel Dashboard](https://vercel.com/dashboard)
|
|
101
|
+
2. Click your project → Settings → Deployment Protection
|
|
102
|
+
3. Set **Vercel Authentication** to **Disabled**
|
|
103
|
+
4. Save changes
|
|
104
|
+
|
|
105
|
+
See the [First-Time Setup Guide](docs/vercel-first-time-setup-guide.md) for a complete walkthrough.
|
|
105
106
|
|
|
106
107
|
## Configuration (optional - can be managed with CLI)
|
|
107
108
|
|
package/doc-builder.config.js
CHANGED
package/html/README.html
CHANGED
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
|
|
37
37
|
<!-- Icons -->
|
|
38
38
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
39
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
39
40
|
|
|
40
41
|
<!-- Mermaid -->
|
|
41
42
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -61,8 +62,8 @@
|
|
|
61
62
|
"name": "Knowcode Ltd",
|
|
62
63
|
"url": "https://knowcode.tech"
|
|
63
64
|
},
|
|
64
|
-
"datePublished": "2025-07-
|
|
65
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T11:03:54.314Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:03:54.314Z",
|
|
66
67
|
"mainEntityOfPage": {
|
|
67
68
|
"@type": "WebPage",
|
|
68
69
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -95,7 +96,7 @@
|
|
|
95
96
|
|
|
96
97
|
<div class="header-actions">
|
|
97
98
|
<div class="deployment-info">
|
|
98
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
|
|
99
100
|
</div>
|
|
100
101
|
|
|
101
102
|
|
|
@@ -146,8 +147,8 @@
|
|
|
146
147
|
<div class="nav-content" >
|
|
147
148
|
<a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
148
149
|
<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>
|
|
149
|
-
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing
|
|
150
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide
|
|
150
|
+
<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 streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
151
152
|
<div class="nav-section" data-level="1">
|
|
152
153
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
153
154
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -172,7 +173,7 @@
|
|
|
172
173
|
<p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
|
|
173
174
|
</blockquote>
|
|
174
175
|
<p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><img src="https://img.shields.io/npm/v/@knowcode/doc-builder" alt="npm version"></a><br><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a></p>
|
|
175
|
-
<h2
|
|
176
|
+
<h2><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h2>
|
|
176
177
|
<p>Create stunning documentation sites in minutes:</p>
|
|
177
178
|
<pre><code class="language-bash"># Install globally
|
|
178
179
|
npm install -g @knowcode/doc-builder
|
|
@@ -180,45 +181,45 @@ npm install -g @knowcode/doc-builder
|
|
|
180
181
|
# Or use with npx
|
|
181
182
|
npx @knowcode/doc-builder@latest deploy
|
|
182
183
|
</code></pre>
|
|
183
|
-
<h2
|
|
184
|
-
<h3
|
|
184
|
+
<h2><i class="ph ph-sparkle" aria-label="special"></i> Features</h2>
|
|
185
|
+
<h3><i class="ph ph-palette" aria-label="design"></i> Beautiful Design</h3>
|
|
185
186
|
<ul>
|
|
186
187
|
<li><strong>Notion-inspired UI</strong> - Clean, modern interface that users love</li>
|
|
187
188
|
<li><strong>Dark mode support</strong> - Automatic theme switching</li>
|
|
188
189
|
<li><strong>Responsive layout</strong> - Perfect on desktop and mobile</li>
|
|
189
190
|
<li><strong>Syntax highlighting</strong> - Beautiful code blocks with language support</li>
|
|
190
191
|
</ul>
|
|
191
|
-
<h3
|
|
192
|
+
<h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Powerful Search & Navigation</h3>
|
|
192
193
|
<ul>
|
|
193
194
|
<li><strong>Full-text search</strong> - Find anything instantly</li>
|
|
194
195
|
<li><strong>Smart navigation</strong> - Hierarchical folder structure</li>
|
|
195
196
|
<li><strong>Breadcrumbs</strong> - Always know where you are</li>
|
|
196
197
|
<li><strong>Keyboard shortcuts</strong> - Navigate like a pro</li>
|
|
197
198
|
</ul>
|
|
198
|
-
<h3
|
|
199
|
+
<h3><i class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Support</h3>
|
|
199
200
|
<ul>
|
|
200
201
|
<li><strong>Mermaid diagrams</strong> - Flowcharts, sequence diagrams, and more</li>
|
|
201
202
|
<li><strong>GitHub-flavored markdown</strong> - Tables, task lists, and strikethrough</li>
|
|
202
203
|
<li><strong>Interactive tooltips</strong> - Document summaries on hover</li>
|
|
203
204
|
<li><strong>Version tracking</strong> - Know which version built your docs</li>
|
|
204
205
|
</ul>
|
|
205
|
-
<h3
|
|
206
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Easy Deployment</h3>
|
|
206
207
|
<ul>
|
|
207
208
|
<li><strong>One-command deploy</strong> - Push to Vercel instantly</li>
|
|
208
209
|
<li><strong>Static site generation</strong> - Fast, secure, and scalable</li>
|
|
209
210
|
<li><strong>Custom domains</strong> - Your docs, your brand</li>
|
|
210
211
|
<li><strong>Preview deployments</strong> - Test before going live</li>
|
|
211
212
|
</ul>
|
|
212
|
-
<h2
|
|
213
|
+
<h2><i class="ph ph-book-open" aria-label="reading"></i> Documentation</h2>
|
|
213
214
|
<p>Visit our <a href="https://www.npmjs.com/package/@knowcode/doc-builder">official documentation</a> for detailed guides and API reference.</p>
|
|
214
|
-
<h2
|
|
215
|
+
<h2><i class="ph ph-target" aria-label="goal"></i> Perfect For</h2>
|
|
215
216
|
<ul>
|
|
216
217
|
<li><strong>Open source projects</strong> - Beautiful docs for your community</li>
|
|
217
218
|
<li><strong>Technical teams</strong> - Internal documentation that developers actually use</li>
|
|
218
219
|
<li><strong>API documentation</strong> - Clear, searchable API references</li>
|
|
219
220
|
<li><strong>Knowledge bases</strong> - Organize and share team knowledge</li>
|
|
220
221
|
</ul>
|
|
221
|
-
<h2
|
|
222
|
+
<h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
|
|
222
223
|
<h3>1. Initialize Your Project</h3>
|
|
223
224
|
<pre><code class="language-bash">npx @knowcode/doc-builder init
|
|
224
225
|
</code></pre>
|
|
@@ -236,9 +237,9 @@ npm install amazing-package
|
|
|
236
237
|
|
|
237
238
|
## Features
|
|
238
239
|
|
|
239
|
-
-
|
|
240
|
-
-
|
|
241
|
-
-
|
|
240
|
+
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature one
|
|
241
|
+
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature two
|
|
242
|
+
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature three
|
|
242
243
|
</code></pre>
|
|
243
244
|
<h3>3. Build & Preview</h3>
|
|
244
245
|
<pre><code class="language-bash"># Build your site
|
|
@@ -250,7 +251,7 @@ npx doc-builder serve
|
|
|
250
251
|
<h3>4. Deploy to Vercel</h3>
|
|
251
252
|
<pre><code class="language-bash">npx doc-builder deploy
|
|
252
253
|
</code></pre>
|
|
253
|
-
<h2
|
|
254
|
+
<h2><i class="ph ph-palette" aria-label="design"></i> Customization</h2>
|
|
254
255
|
<p>Configure your site with <code>doc-builder.config.js</code>:</p>
|
|
255
256
|
<pre><code class="language-javascript">module.exports = {
|
|
256
257
|
siteName: 'Your Amazing Docs',
|
|
@@ -262,7 +263,7 @@ npx doc-builder serve
|
|
|
262
263
|
}
|
|
263
264
|
};
|
|
264
265
|
</code></pre>
|
|
265
|
-
<h2
|
|
266
|
+
<h2><i class="ph ph-chart-bar" aria-label="chart"></i> Mermaid Diagram Support</h2>
|
|
266
267
|
<p>Create beautiful diagrams in your markdown:</p>
|
|
267
268
|
<div class="mermaid-wrapper">
|
|
268
269
|
<div class="mermaid-title">Diagram</div>
|
|
@@ -274,13 +275,13 @@ npx doc-builder serve
|
|
|
274
275
|
style A fill:#e1f5fe
|
|
275
276
|
style D fill:#c8e6c9</div>
|
|
276
277
|
</div>
|
|
277
|
-
<h2
|
|
278
|
+
<h2><i class="ph ph-lock" aria-label="locked"></i> Optional Authentication</h2>
|
|
278
279
|
<p>Protect sensitive documentation with built-in authentication:</p>
|
|
279
280
|
<pre><code class="language-javascript">features: {
|
|
280
281
|
authentication: true
|
|
281
282
|
}
|
|
282
283
|
</code></pre>
|
|
283
|
-
<h2
|
|
284
|
+
<h2><i class="ph ph-star-four" aria-label="sparkle"></i> Why doc-builder?</h2>
|
|
284
285
|
<ul>
|
|
285
286
|
<li><strong>Zero configuration</strong> - Works out of the box</li>
|
|
286
287
|
<li><strong>Lightning fast</strong> - Static site generation for instant loading</li>
|
|
@@ -289,13 +290,13 @@ npx doc-builder serve
|
|
|
289
290
|
<li><strong>Version control</strong> - Track changes with Git</li>
|
|
290
291
|
<li><strong>Open source</strong> - MIT licensed</li>
|
|
291
292
|
</ul>
|
|
292
|
-
<h2
|
|
293
|
+
<h2><i class="ph ph-handshake" aria-label="partnership"></i> Contributing</h2>
|
|
293
294
|
<p>We welcome contributions! Check out our <a href="https://github.com/knowcode/doc-builder">contribution guide</a> to get started.</p>
|
|
294
|
-
<h2
|
|
295
|
+
<h2><i class="ph ph-note-pencil" aria-label="edit"></i> License</h2>
|
|
295
296
|
<p>MIT © KnowCode</p>
|
|
296
297
|
<hr>
|
|
297
298
|
<div align="center">
|
|
298
|
-
<p>Built with
|
|
299
|
+
<p>Built with <i class="ph ph-heart" aria-label="love"></i> by developers, for developers</p>
|
|
299
300
|
<p>
|
|
300
301
|
<a href="https://www.npmjs.com/package/@knowcode/doc-builder">npm</a> •
|
|
301
302
|
<a href="https://github.com/knowcode/doc-builder">GitHub</a> •
|
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
|
|
37
37
|
<!-- Icons -->
|
|
38
38
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
39
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
39
40
|
|
|
40
41
|
<!-- Mermaid -->
|
|
41
42
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -61,8 +62,8 @@
|
|
|
61
62
|
"name": "Knowcode Ltd",
|
|
62
63
|
"url": "https://knowcode.tech"
|
|
63
64
|
},
|
|
64
|
-
"datePublished": "2025-07-
|
|
65
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T11:03:54.323Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:03:54.323Z",
|
|
66
67
|
"mainEntityOfPage": {
|
|
67
68
|
"@type": "WebPage",
|
|
68
69
|
"@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
|
|
@@ -95,7 +96,7 @@
|
|
|
95
96
|
|
|
96
97
|
<div class="header-actions">
|
|
97
98
|
<div class="deployment-info">
|
|
98
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
|
|
99
100
|
</div>
|
|
100
101
|
|
|
101
102
|
|
|
@@ -146,8 +147,8 @@
|
|
|
146
147
|
<div class="nav-content" >
|
|
147
148
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
148
149
|
<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>
|
|
149
|
-
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing
|
|
150
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide
|
|
150
|
+
<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 streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
151
152
|
<div class="nav-section" data-level="1">
|
|
152
153
|
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
153
154
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -168,7 +169,7 @@
|
|
|
168
169
|
<main class="content">
|
|
169
170
|
<div class="content-inner">
|
|
170
171
|
<h1>Documentation Index</h1>
|
|
171
|
-
<p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>:
|
|
172
|
+
<p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
|
|
172
173
|
<h2>Overview</h2>
|
|
173
174
|
<p>This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.</p>
|
|
174
175
|
<h2>Directory Structure</h2>
|
|
@@ -183,7 +184,7 @@
|
|
|
183
184
|
└── troubleshooting-guide.md # Common issues and solutions
|
|
184
185
|
</code></pre>
|
|
185
186
|
<h2>Documentation Categories</h2>
|
|
186
|
-
<h3
|
|
187
|
+
<h3><i class="ph ph-books" aria-label="documentation"></i> Core Documentation</h3>
|
|
187
188
|
<table>
|
|
188
189
|
<thead>
|
|
189
190
|
<tr>
|
|
@@ -208,7 +209,7 @@
|
|
|
208
209
|
<td>Claude Code integration guide</td>
|
|
209
210
|
</tr>
|
|
210
211
|
</tbody></table>
|
|
211
|
-
<h3
|
|
212
|
+
<h3><i class="ph ph-book-open" aria-label="reading"></i> Guides</h3>
|
|
212
213
|
<table>
|
|
213
214
|
<thead>
|
|
214
215
|
<tr>
|
|
@@ -278,7 +279,7 @@
|
|
|
278
279
|
|
|
279
280
|
**Generated**: YYYY-MM-DD HH:MM UTC
|
|
280
281
|
**Status**: Draft/Complete
|
|
281
|
-
**Verified**:
|
|
282
|
+
**Verified**: <i class="ph ph-check-circle" aria-label="checked"></i>/<i class="ph ph-question" aria-label="question"></i>
|
|
282
283
|
|
|
283
284
|
## Overview
|
|
284
285
|
|
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
|
|
37
37
|
<!-- Icons -->
|
|
38
38
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
39
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
39
40
|
|
|
40
41
|
<!-- Mermaid -->
|
|
41
42
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -61,8 +62,8 @@
|
|
|
61
62
|
"name": "Knowcode Ltd",
|
|
62
63
|
"url": "https://knowcode.tech"
|
|
63
64
|
},
|
|
64
|
-
"datePublished": "2025-07-
|
|
65
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T11:03:54.326Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:03:54.326Z",
|
|
66
67
|
"mainEntityOfPage": {
|
|
67
68
|
"@type": "WebPage",
|
|
68
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
|
|
@@ -101,7 +102,7 @@
|
|
|
101
102
|
|
|
102
103
|
<div class="header-actions">
|
|
103
104
|
<div class="deployment-info">
|
|
104
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
|
|
105
106
|
</div>
|
|
106
107
|
|
|
107
108
|
|
|
@@ -152,8 +153,8 @@
|
|
|
152
153
|
<div class="nav-content" >
|
|
153
154
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
154
155
|
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
155
|
-
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing
|
|
156
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide
|
|
156
|
+
<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 streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
157
158
|
<div class="nav-section" data-level="1">
|
|
158
159
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
159
160
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -174,25 +175,25 @@
|
|
|
174
175
|
<main class="content">
|
|
175
176
|
<div class="content-inner">
|
|
176
177
|
<h1>Authentication Guide for @knowcode/doc-builder</h1>
|
|
177
|
-
<p><strong>Generated</strong>: 2025-07-21 18:30 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>:
|
|
178
|
+
<p><strong>Generated</strong>: 2025-07-21 18:30 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
|
|
178
179
|
<h2>Overview</h2>
|
|
179
180
|
<p>This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic username/password access control.</p>
|
|
180
181
|
<h2>What is Authentication?</h2>
|
|
181
182
|
<p>The authentication feature in doc-builder provides a simple way to protect your documentation from unauthorized access. When enabled, users must log in with a username and password before viewing any documentation pages.</p>
|
|
182
183
|
<h3>Features</h3>
|
|
183
184
|
<ul>
|
|
184
|
-
<li
|
|
185
|
-
<li
|
|
186
|
-
<li
|
|
187
|
-
<li
|
|
188
|
-
<li
|
|
185
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Client-side authentication</strong> - Works with static site hosting</li>
|
|
186
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Cookie-based sessions</strong> - Users stay logged in across pages</li>
|
|
187
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Redirect handling</strong> - Returns users to requested page after login</li>
|
|
188
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Logout functionality</strong> - Clear session and return to login</li>
|
|
189
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Customizable credentials</strong> - Set your own username/password</li>
|
|
189
190
|
</ul>
|
|
190
191
|
<h3>Limitations</h3>
|
|
191
192
|
<ul>
|
|
192
|
-
<li
|
|
193
|
-
<li
|
|
194
|
-
<li
|
|
195
|
-
<li
|
|
193
|
+
<li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Basic security</strong> - Suitable for casual protection only</li>
|
|
194
|
+
<li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Client-side validation</strong> - Not suitable for highly sensitive data</li>
|
|
195
|
+
<li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Single user</strong> - No multi-user or role-based access</li>
|
|
196
|
+
<li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Credentials in JavaScript</strong> - Visible in browser developer tools</li>
|
|
196
197
|
</ul>
|
|
197
198
|
<h2>How Authentication Works</h2>
|
|
198
199
|
<div class="mermaid-wrapper">
|
|
@@ -298,7 +299,7 @@
|
|
|
298
299
|
<li><strong>Logout</strong>: Click logout link in header (when available)</li>
|
|
299
300
|
</ol>
|
|
300
301
|
<h2>Security Considerations</h2>
|
|
301
|
-
<h3
|
|
302
|
+
<h3><i class="ph ph-warning-circle" aria-label="warning"></i> Important Warnings</h3>
|
|
302
303
|
<ol>
|
|
303
304
|
<li><strong>Client-Side Only</strong>: Authentication happens in the browser, making it unsuitable for truly sensitive data</li>
|
|
304
305
|
<li><strong>Visible Credentials</strong>: Username/password are embedded in JavaScript and visible to anyone who views page source</li>
|
|
@@ -306,7 +307,7 @@
|
|
|
306
307
|
<li><strong>Static Files</strong>: All documentation files are still publicly accessible if URLs are known</li>
|
|
307
308
|
</ol>
|
|
308
309
|
<h3>When to Use</h3>
|
|
309
|
-
<p
|
|
310
|
+
<p><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Good for:</strong></p>
|
|
310
311
|
<ul>
|
|
311
312
|
<li>Internal team documentation</li>
|
|
312
313
|
<li>Preview deployments</li>
|
|
@@ -314,7 +315,7 @@
|
|
|
314
315
|
<li>Preventing search engine indexing</li>
|
|
315
316
|
<li>Client presentations</li>
|
|
316
317
|
</ul>
|
|
317
|
-
<p
|
|
318
|
+
<p><i class="ph ph-x-circle" aria-label="error"></i> <strong>Not suitable for:</strong></p>
|
|
318
319
|
<ul>
|
|
319
320
|
<li>Highly confidential information</li>
|
|
320
321
|
<li>Personal data (GDPR/privacy)</li>
|
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
|
|
37
37
|
<!-- Icons -->
|
|
38
38
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
39
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
39
40
|
|
|
40
41
|
<!-- Mermaid -->
|
|
41
42
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -61,8 +62,8 @@
|
|
|
61
62
|
"name": "Knowcode Ltd",
|
|
62
63
|
"url": "https://knowcode.tech"
|
|
63
64
|
},
|
|
64
|
-
"datePublished": "2025-07-
|
|
65
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T11:03:54.329Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:03:54.329Z",
|
|
66
67
|
"mainEntityOfPage": {
|
|
67
68
|
"@type": "WebPage",
|
|
68
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html"
|
|
@@ -101,7 +102,7 @@
|
|
|
101
102
|
|
|
102
103
|
<div class="header-actions">
|
|
103
104
|
<div class="deployment-info">
|
|
104
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
|
|
105
106
|
</div>
|
|
106
107
|
|
|
107
108
|
|
|
@@ -152,8 +153,8 @@
|
|
|
152
153
|
<div class="nav-content" >
|
|
153
154
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
154
155
|
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
155
|
-
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing
|
|
156
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide
|
|
156
|
+
<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 streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
157
158
|
<div class="nav-section" data-level="1">
|
|
158
159
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
159
160
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -174,7 +175,7 @@
|
|
|
174
175
|
<main class="content">
|
|
175
176
|
<div class="content-inner">
|
|
176
177
|
<h1>Claude + CLAUDE.md Documentation Workflow Guide</h1>
|
|
177
|
-
<p><strong>Generated</strong>: 2025-07-21 10:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>:
|
|
178
|
+
<p><strong>Generated</strong>: 2025-07-21 10:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
|
|
178
179
|
<h2>Overview</h2>
|
|
179
180
|
<p>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 Vercel using the @knowcode/doc-builder tool.</p>
|
|
180
181
|
<h2>Workflow Overview</h2>
|
|
@@ -213,7 +214,7 @@
|
|
|
213
214
|
|
|
214
215
|
### Content Requirements
|
|
215
216
|
- Include mermaid diagrams for complex workflows
|
|
216
|
-
- Mark verified (
|
|
217
|
+
- Mark verified (<i class="ph ph-check-circle" aria-label="checked"></i>) vs speculated (<i class="ph ph-question" aria-label="question"></i>) information
|
|
217
218
|
- Add timestamps to all documents
|
|
218
219
|
- Include practical examples
|
|
219
220
|
|
|
@@ -225,7 +226,7 @@
|
|
|
225
226
|
|
|
226
227
|
### Metadata Format
|
|
227
228
|
</code></pre>
|
|
228
|
-
<p><strong>Generated</strong>: YYYY-MM-DD HH:MM UTC<br><strong>Status</strong>: Draft/Complete<br><strong>Verified</strong>:
|
|
229
|
+
<p><strong>Generated</strong>: YYYY-MM-DD HH:MM UTC<br><strong>Status</strong>: Draft/Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i>/<i class="ph ph-question" aria-label="question"></i></p>
|
|
229
230
|
<pre><code>
|
|
230
231
|
</code></pre>
|
|
231
232
|
<h3>1.2 Global CLAUDE.md Best Practices</h3>
|
|
@@ -474,25 +475,25 @@ npm run deploy:docs
|
|
|
474
475
|
## Best Practices Summary
|
|
475
476
|
|
|
476
477
|
### Documentation Creation
|
|
477
|
-
1.
|
|
478
|
-
2.
|
|
479
|
-
3.
|
|
480
|
-
4.
|
|
481
|
-
5.
|
|
478
|
+
1. <i class="ph ph-check-circle" aria-label="checked"></i> Use CLAUDE.md to maintain consistency
|
|
479
|
+
2. <i class="ph ph-check-circle" aria-label="checked"></i> Include visual diagrams for complex concepts
|
|
480
|
+
3. <i class="ph ph-check-circle" aria-label="checked"></i> Provide practical examples
|
|
481
|
+
4. <i class="ph ph-check-circle" aria-label="checked"></i> Mark verification status
|
|
482
|
+
5. <i class="ph ph-check-circle" aria-label="checked"></i> Keep documentation close to code
|
|
482
483
|
|
|
483
484
|
### Claude Interaction
|
|
484
|
-
1.
|
|
485
|
-
2.
|
|
486
|
-
3.
|
|
487
|
-
4.
|
|
488
|
-
5.
|
|
485
|
+
1. <i class="ph ph-check-circle" aria-label="checked"></i> Provide clear, specific requests
|
|
486
|
+
2. <i class="ph ph-check-circle" aria-label="checked"></i> Reference existing patterns
|
|
487
|
+
3. <i class="ph ph-check-circle" aria-label="checked"></i> Request iterative improvements
|
|
488
|
+
4. <i class="ph ph-check-circle" aria-label="checked"></i> Verify technical accuracy
|
|
489
|
+
5. <i class="ph ph-check-circle" aria-label="checked"></i> Ask for troubleshooting sections
|
|
489
490
|
|
|
490
491
|
### Deployment
|
|
491
|
-
1.
|
|
492
|
-
2.
|
|
493
|
-
3.
|
|
494
|
-
4.
|
|
495
|
-
5.
|
|
492
|
+
1. <i class="ph ph-check-circle" aria-label="checked"></i> Test locally before deploying
|
|
493
|
+
2. <i class="ph ph-check-circle" aria-label="checked"></i> Use preview deployments first
|
|
494
|
+
3. <i class="ph ph-check-circle" aria-label="checked"></i> Configure custom domains
|
|
495
|
+
4. <i class="ph ph-check-circle" aria-label="checked"></i> Enable HTTPS
|
|
496
|
+
5. <i class="ph ph-check-circle" aria-label="checked"></i> Monitor deployment health
|
|
496
497
|
|
|
497
498
|
## Common Issues and Solutions
|
|
498
499
|
|