@knowcode/doc-builder 1.5.12 → 1.5.14

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 CHANGED
@@ -5,6 +5,37 @@ 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.14] - 2025-07-22
9
+
10
+ ### Fixed
11
+ - Fixed vertical alignment of Phosphor icons - they now properly center with text
12
+ - Added CSS rules for proper icon positioning in different contexts (headings, lists, tables)
13
+ - Icons no longer appear too high relative to the text baseline
14
+
15
+ ### Changed
16
+ - Added comprehensive Phosphor icon CSS alignment rules at the end of notion-style.css
17
+ - Fine-tuned icon positioning with `vertical-align: middle` and slight top offset adjustment
18
+
19
+ ## [1.5.13] - 2025-07-22
20
+
21
+ ### Added
22
+ - **Phosphor Icons Integration** - Automatically convert Unicode emojis to beautiful Phosphor icons in generated HTML
23
+ - Comprehensive emoji-to-icon mapping with 200+ supported emojis
24
+ - Configurable icon weights (thin, light, regular, bold, fill, duotone)
25
+ - Configurable icon size relative to text
26
+ - Accessibility support with proper aria-labels for all icons
27
+ - New `phosphor-icons-guide.md` documentation
28
+
29
+ ### Changed
30
+ - HTML template now includes Phosphor Icons CDN when feature is enabled
31
+ - Post-processing step to replace emojis with icon tags after markdown parsing
32
+
33
+ ### Technical Details
34
+ - Added `lib/emoji-mapper.js` with comprehensive emoji mappings
35
+ - Updated `core-builder.js` to process emojis during HTML generation
36
+ - Added configuration options: `phosphorIcons`, `phosphorWeight`, `phosphorSize`
37
+ - Icons inherit text color and can be styled with CSS
38
+
8
39
  ## [1.5.12] - 2025-07-22
9
40
 
10
41
  ### Documentation
@@ -1900,4 +1900,36 @@ tr:hover {
1900
1900
  background: #451a1a;
1901
1901
  border-color: #7f1d1d;
1902
1902
  color: #fca5a5;
1903
+ }
1904
+
1905
+ /* Phosphor Icons Alignment */
1906
+ .ph {
1907
+ display: inline-block;
1908
+ vertical-align: middle;
1909
+ line-height: 1;
1910
+ position: relative;
1911
+ top: -0.05em; /* Fine-tune vertical centering */
1912
+ }
1913
+
1914
+ /* Ensure icons in headings are properly sized */
1915
+ h1 .ph, h2 .ph, h3 .ph, h4 .ph, h5 .ph, h6 .ph {
1916
+ vertical-align: baseline;
1917
+ top: -0.1em;
1918
+ }
1919
+
1920
+ /* Icons in lists need special handling */
1921
+ li .ph {
1922
+ margin-right: 0.2em;
1923
+ }
1924
+
1925
+ /* Icons in tables */
1926
+ td .ph, th .ph {
1927
+ vertical-align: middle;
1928
+ }
1929
+
1930
+ /* Icons in navigation */
1931
+ .nav-item .ph,
1932
+ .nav-title .ph {
1933
+ vertical-align: middle;
1934
+ top: 0; /* Navigation items are flex, so no adjustment needed */
1903
1935
  }
@@ -8,7 +8,8 @@ module.exports = {
8
8
  "authentication": false,
9
9
  "changelog": true,
10
10
  "mermaid": true,
11
- "darkMode": true
11
+ "darkMode": true,
12
+ "phosphorIcons": true
12
13
  },
13
14
  "seo": {
14
15
  "enabled": true,
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-22T08:32:13.098Z",
65
- "dateModified": "2025-07-22T08:32:13.098Z",
65
+ "datePublished": "2025-07-22T11:08:51.999Z",
66
+ "dateModified": "2025-07-22T11:08:51.999Z",
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.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
+ <span class="deployment-date" title="Built with doc-builder v1.5.13">Last updated: Jul 22, 2025, 11:08 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 and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
150
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
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
@@ -157,6 +158,7 @@
157
158
  <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>
158
159
  <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
159
160
  <a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site&#039;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
+ <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>
160
162
  <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>
161
163
  <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>
162
164
  <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
@@ -172,7 +174,7 @@
172
174
  <p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
173
175
  </blockquote>
174
176
  <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>🚀 Quick Start</h2>
177
+ <h2><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h2>
176
178
  <p>Create stunning documentation sites in minutes:</p>
177
179
  <pre><code class="language-bash"># Install globally
178
180
  npm install -g @knowcode/doc-builder
@@ -180,45 +182,45 @@ npm install -g @knowcode/doc-builder
180
182
  # Or use with npx
181
183
  npx @knowcode/doc-builder@latest deploy
182
184
  </code></pre>
183
- <h2>✨ Features</h2>
184
- <h3>🎨 Beautiful Design</h3>
185
+ <h2><i class="ph ph-sparkle" aria-label="special"></i> Features</h2>
186
+ <h3><i class="ph ph-palette" aria-label="design"></i> Beautiful Design</h3>
185
187
  <ul>
186
188
  <li><strong>Notion-inspired UI</strong> - Clean, modern interface that users love</li>
187
189
  <li><strong>Dark mode support</strong> - Automatic theme switching</li>
188
190
  <li><strong>Responsive layout</strong> - Perfect on desktop and mobile</li>
189
191
  <li><strong>Syntax highlighting</strong> - Beautiful code blocks with language support</li>
190
192
  </ul>
191
- <h3>🔍 Powerful Search &amp; Navigation</h3>
193
+ <h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Powerful Search &amp; Navigation</h3>
192
194
  <ul>
193
195
  <li><strong>Full-text search</strong> - Find anything instantly</li>
194
196
  <li><strong>Smart navigation</strong> - Hierarchical folder structure</li>
195
197
  <li><strong>Breadcrumbs</strong> - Always know where you are</li>
196
198
  <li><strong>Keyboard shortcuts</strong> - Navigate like a pro</li>
197
199
  </ul>
198
- <h3>📊 Rich Content Support</h3>
200
+ <h3><i class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Support</h3>
199
201
  <ul>
200
202
  <li><strong>Mermaid diagrams</strong> - Flowcharts, sequence diagrams, and more</li>
201
203
  <li><strong>GitHub-flavored markdown</strong> - Tables, task lists, and strikethrough</li>
202
204
  <li><strong>Interactive tooltips</strong> - Document summaries on hover</li>
203
205
  <li><strong>Version tracking</strong> - Know which version built your docs</li>
204
206
  </ul>
205
- <h3>🚀 Easy Deployment</h3>
207
+ <h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Easy Deployment</h3>
206
208
  <ul>
207
209
  <li><strong>One-command deploy</strong> - Push to Vercel instantly</li>
208
210
  <li><strong>Static site generation</strong> - Fast, secure, and scalable</li>
209
211
  <li><strong>Custom domains</strong> - Your docs, your brand</li>
210
212
  <li><strong>Preview deployments</strong> - Test before going live</li>
211
213
  </ul>
212
- <h2>📖 Documentation</h2>
214
+ <h2><i class="ph ph-book-open" aria-label="reading"></i> Documentation</h2>
213
215
  <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>🎯 Perfect For</h2>
216
+ <h2><i class="ph ph-target" aria-label="goal"></i> Perfect For</h2>
215
217
  <ul>
216
218
  <li><strong>Open source projects</strong> - Beautiful docs for your community</li>
217
219
  <li><strong>Technical teams</strong> - Internal documentation that developers actually use</li>
218
220
  <li><strong>API documentation</strong> - Clear, searchable API references</li>
219
221
  <li><strong>Knowledge bases</strong> - Organize and share team knowledge</li>
220
222
  </ul>
221
- <h2>🛠️ Simple Workflow</h2>
223
+ <h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
222
224
  <h3>1. Initialize Your Project</h3>
223
225
  <pre><code class="language-bash">npx @knowcode/doc-builder init
224
226
  </code></pre>
@@ -236,9 +238,9 @@ npm install amazing-package
236
238
 
237
239
  ## Features
238
240
 
239
- - Feature one
240
- - Feature two
241
- - Feature three
241
+ - <i class="ph ph-check-circle" aria-label="checked"></i> Feature one
242
+ - <i class="ph ph-check-circle" aria-label="checked"></i> Feature two
243
+ - <i class="ph ph-check-circle" aria-label="checked"></i> Feature three
242
244
  </code></pre>
243
245
  <h3>3. Build &amp; Preview</h3>
244
246
  <pre><code class="language-bash"># Build your site
@@ -250,7 +252,7 @@ npx doc-builder serve
250
252
  <h3>4. Deploy to Vercel</h3>
251
253
  <pre><code class="language-bash">npx doc-builder deploy
252
254
  </code></pre>
253
- <h2>🎨 Customization</h2>
255
+ <h2><i class="ph ph-palette" aria-label="design"></i> Customization</h2>
254
256
  <p>Configure your site with <code>doc-builder.config.js</code>:</p>
255
257
  <pre><code class="language-javascript">module.exports = {
256
258
  siteName: &#39;Your Amazing Docs&#39;,
@@ -262,7 +264,7 @@ npx doc-builder serve
262
264
  }
263
265
  };
264
266
  </code></pre>
265
- <h2>📊 Mermaid Diagram Support</h2>
267
+ <h2><i class="ph ph-chart-bar" aria-label="chart"></i> Mermaid Diagram Support</h2>
266
268
  <p>Create beautiful diagrams in your markdown:</p>
267
269
  <div class="mermaid-wrapper">
268
270
  <div class="mermaid-title">Diagram</div>
@@ -274,13 +276,13 @@ npx doc-builder serve
274
276
  style A fill:#e1f5fe
275
277
  style D fill:#c8e6c9</div>
276
278
  </div>
277
- <h2>🔒 Optional Authentication</h2>
279
+ <h2><i class="ph ph-lock" aria-label="locked"></i> Optional Authentication</h2>
278
280
  <p>Protect sensitive documentation with built-in authentication:</p>
279
281
  <pre><code class="language-javascript">features: {
280
282
  authentication: true
281
283
  }
282
284
  </code></pre>
283
- <h2>🌟 Why doc-builder?</h2>
285
+ <h2><i class="ph ph-star-four" aria-label="sparkle"></i> Why doc-builder?</h2>
284
286
  <ul>
285
287
  <li><strong>Zero configuration</strong> - Works out of the box</li>
286
288
  <li><strong>Lightning fast</strong> - Static site generation for instant loading</li>
@@ -289,13 +291,13 @@ npx doc-builder serve
289
291
  <li><strong>Version control</strong> - Track changes with Git</li>
290
292
  <li><strong>Open source</strong> - MIT licensed</li>
291
293
  </ul>
292
- <h2>🤝 Contributing</h2>
294
+ <h2><i class="ph ph-handshake" aria-label="partnership"></i> Contributing</h2>
293
295
  <p>We welcome contributions! Check out our <a href="https://github.com/knowcode/doc-builder">contribution guide</a> to get started.</p>
294
- <h2>📝 License</h2>
296
+ <h2><i class="ph ph-note-pencil" aria-label="edit"></i> License</h2>
295
297
  <p>MIT © KnowCode</p>
296
298
  <hr>
297
299
  <div align="center">
298
- <p>Built with ❤️ by developers, for developers</p>
300
+ <p>Built with <i class="ph ph-heart" aria-label="love"></i> by developers, for developers</p>
299
301
  <p>
300
302
  <a href="https://www.npmjs.com/package/@knowcode/doc-builder">npm</a> •
301
303
  <a href="https://github.com/knowcode/doc-builder">GitHub</a> •
@@ -1900,4 +1900,36 @@ tr:hover {
1900
1900
  background: #451a1a;
1901
1901
  border-color: #7f1d1d;
1902
1902
  color: #fca5a5;
1903
+ }
1904
+
1905
+ /* Phosphor Icons Alignment */
1906
+ .ph {
1907
+ display: inline-block;
1908
+ vertical-align: middle;
1909
+ line-height: 1;
1910
+ position: relative;
1911
+ top: -0.05em; /* Fine-tune vertical centering */
1912
+ }
1913
+
1914
+ /* Ensure icons in headings are properly sized */
1915
+ h1 .ph, h2 .ph, h3 .ph, h4 .ph, h5 .ph, h6 .ph {
1916
+ vertical-align: baseline;
1917
+ top: -0.1em;
1918
+ }
1919
+
1920
+ /* Icons in lists need special handling */
1921
+ li .ph {
1922
+ margin-right: 0.2em;
1923
+ }
1924
+
1925
+ /* Icons in tables */
1926
+ td .ph, th .ph {
1927
+ vertical-align: middle;
1928
+ }
1929
+
1930
+ /* Icons in navigation */
1931
+ .nav-item .ph,
1932
+ .nav-title .ph {
1933
+ vertical-align: middle;
1934
+ top: 0; /* Navigation items are flex, so no adjustment needed */
1903
1935
  }
@@ -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-22T08:32:13.109Z",
65
- "dateModified": "2025-07-22T08:32:13.109Z",
65
+ "datePublished": "2025-07-22T11:08:52.109Z",
66
+ "dateModified": "2025-07-22T11:08:52.109Z",
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.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
+ <span class="deployment-date" title="Built with doc-builder v1.5.13">Last updated: Jul 22, 2025, 11:08 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 and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
150
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
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
@@ -157,6 +158,7 @@
157
158
  <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>
158
159
  <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
159
160
  <a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site&#039;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
+ <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>
160
162
  <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>
161
163
  <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>
162
164
  <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
@@ -168,7 +170,7 @@
168
170
  <main class="content">
169
171
  <div class="content-inner">
170
172
  <h1>Documentation Index</h1>
171
- <p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
173
+ <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
174
  <h2>Overview</h2>
173
175
  <p>This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.</p>
174
176
  <h2>Directory Structure</h2>
@@ -179,11 +181,13 @@
179
181
  └── guides/ # How-to guides and standards
180
182
  ├── authentication-guide.md # Authentication setup and usage
181
183
  ├── documentation-standards.md # Documentation standards
184
+ ├── phosphor-icons-guide.md # Emoji to icon conversion
182
185
  ├── seo-guide.md # SEO features and configuration
186
+ ├── seo-optimization-guide.md # SEO best practices
183
187
  └── troubleshooting-guide.md # Common issues and solutions
184
188
  </code></pre>
185
189
  <h2>Documentation Categories</h2>
186
- <h3>📚 Core Documentation</h3>
190
+ <h3><i class="ph ph-books" aria-label="documentation"></i> Core Documentation</h3>
187
191
  <table>
188
192
  <thead>
189
193
  <tr>
@@ -208,7 +212,7 @@
208
212
  <td>Claude Code integration guide</td>
209
213
  </tr>
210
214
  </tbody></table>
211
- <h3>📖 Guides</h3>
215
+ <h3><i class="ph ph-book-open" aria-label="reading"></i> Guides</h3>
212
216
  <table>
213
217
  <thead>
214
218
  <tr>
@@ -233,6 +237,16 @@
233
237
  <td>SEO features and configuration</td>
234
238
  </tr>
235
239
  <tr>
240
+ <td>SEO Optimization Guide</td>
241
+ <td><a href="./guides/seo-optimization-guide.md">guides/seo-optimization-guide.md</a></td>
242
+ <td>Comprehensive SEO best practices</td>
243
+ </tr>
244
+ <tr>
245
+ <td>Phosphor Icons Guide</td>
246
+ <td><a href="./guides/phosphor-icons-guide.md">guides/phosphor-icons-guide.md</a></td>
247
+ <td>Emoji to icon conversion feature</td>
248
+ </tr>
249
+ <tr>
236
250
  <td>Troubleshooting Guide</td>
237
251
  <td><a href="./guides/troubleshooting-guide.md">guides/troubleshooting-guide.md</a></td>
238
252
  <td>Common issues and solutions</td>
@@ -278,7 +292,7 @@
278
292
 
279
293
  **Generated**: YYYY-MM-DD HH:MM UTC
280
294
  **Status**: Draft/Complete
281
- **Verified**: ✅/❓
295
+ **Verified**: <i class="ph ph-check-circle" aria-label="checked"></i>/<i class="ph ph-question" aria-label="question"></i>
282
296
 
283
297
  ## Overview
284
298
 
@@ -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-22T08:32:13.111Z",
65
- "dateModified": "2025-07-22T08:32:13.111Z",
65
+ "datePublished": "2025-07-22T11:08:52.112Z",
66
+ "dateModified": "2025-07-22T11:08:52.112Z",
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.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.13">Last updated: Jul 22, 2025, 11:08 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 and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
156
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
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
@@ -163,6 +164,7 @@
163
164
  <a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
164
165
  <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
165
166
  <a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site&#039;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
+ <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>
166
168
  <a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
167
169
  <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>
168
170
  <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
@@ -174,25 +176,25 @@
174
176
  <main class="content">
175
177
  <div class="content-inner">
176
178
  <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>: ✅</p>
179
+ <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
180
  <h2>Overview</h2>
179
181
  <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
182
  <h2>What is Authentication?</h2>
181
183
  <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
184
  <h3>Features</h3>
183
185
  <ul>
184
- <li>✅ <strong>Client-side authentication</strong> - Works with static site hosting</li>
185
- <li>✅ <strong>Cookie-based sessions</strong> - Users stay logged in across pages</li>
186
- <li>✅ <strong>Redirect handling</strong> - Returns users to requested page after login</li>
187
- <li>✅ <strong>Logout functionality</strong> - Clear session and return to login</li>
188
- <li>✅ <strong>Customizable credentials</strong> - Set your own username/password</li>
186
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Client-side authentication</strong> - Works with static site hosting</li>
187
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Cookie-based sessions</strong> - Users stay logged in across pages</li>
188
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Redirect handling</strong> - Returns users to requested page after login</li>
189
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Logout functionality</strong> - Clear session and return to login</li>
190
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Customizable credentials</strong> - Set your own username/password</li>
189
191
  </ul>
190
192
  <h3>Limitations</h3>
191
193
  <ul>
192
- <li>⚠️ <strong>Basic security</strong> - Suitable for casual protection only</li>
193
- <li>⚠️ <strong>Client-side validation</strong> - Not suitable for highly sensitive data</li>
194
- <li>⚠️ <strong>Single user</strong> - No multi-user or role-based access</li>
195
- <li>⚠️ <strong>Credentials in JavaScript</strong> - Visible in browser developer tools</li>
194
+ <li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Basic security</strong> - Suitable for casual protection only</li>
195
+ <li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Client-side validation</strong> - Not suitable for highly sensitive data</li>
196
+ <li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Single user</strong> - No multi-user or role-based access</li>
197
+ <li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Credentials in JavaScript</strong> - Visible in browser developer tools</li>
196
198
  </ul>
197
199
  <h2>How Authentication Works</h2>
198
200
  <div class="mermaid-wrapper">
@@ -298,7 +300,7 @@
298
300
  <li><strong>Logout</strong>: Click logout link in header (when available)</li>
299
301
  </ol>
300
302
  <h2>Security Considerations</h2>
301
- <h3>⚠️ Important Warnings</h3>
303
+ <h3><i class="ph ph-warning-circle" aria-label="warning"></i> Important Warnings</h3>
302
304
  <ol>
303
305
  <li><strong>Client-Side Only</strong>: Authentication happens in the browser, making it unsuitable for truly sensitive data</li>
304
306
  <li><strong>Visible Credentials</strong>: Username/password are embedded in JavaScript and visible to anyone who views page source</li>
@@ -306,7 +308,7 @@
306
308
  <li><strong>Static Files</strong>: All documentation files are still publicly accessible if URLs are known</li>
307
309
  </ol>
308
310
  <h3>When to Use</h3>
309
- <p>✅ <strong>Good for:</strong></p>
311
+ <p><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Good for:</strong></p>
310
312
  <ul>
311
313
  <li>Internal team documentation</li>
312
314
  <li>Preview deployments</li>
@@ -314,7 +316,7 @@
314
316
  <li>Preventing search engine indexing</li>
315
317
  <li>Client presentations</li>
316
318
  </ul>
317
- <p>❌ <strong>Not suitable for:</strong></p>
319
+ <p><i class="ph ph-x-circle" aria-label="error"></i> <strong>Not suitable for:</strong></p>
318
320
  <ul>
319
321
  <li>Highly confidential information</li>
320
322
  <li>Personal data (GDPR/privacy)</li>