@knowcode/doc-builder 1.9.29 → 1.9.31
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/assets/js/main.js +7 -0
- package/lib/core-builder.js +18 -1
- package/package.json +12 -2
- package/.claude/settings.local.json +0 -56
- package/CACHE-BUSTING-GUIDE.md +0 -82
- package/CLAUDE.md +0 -86
- package/CONTRIBUTING.md +0 -148
- package/GITHUB_SETUP.md +0 -203
- package/RELEASE-NOTES-1.7.5.md +0 -64
- package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
- package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
- package/add-user-clive.sql +0 -35
- package/add-user-lindsay-fixed.sql +0 -85
- package/add-user-lindsay.sql +0 -68
- package/add-user-pmorgan.sql +0 -35
- package/add-user-robbie.sql +0 -35
- package/add-wru-users.sql +0 -105
- package/debug-login.sql +0 -30
- package/doc-builder.config.js +0 -126
- package/doc-builder.config.js.backup.1753793768283 +0 -47
- package/doc-builder.config.js.backup.1753803964423 +0 -114
- package/doc-builder.config.js.backup.1753945707032 +0 -115
- package/doc-builder.config.js.backup.1754059241330 +0 -115
- package/doc-builder.config.js.backup.1754119567787 +0 -123
- package/doc-builder.config.js.backup.1754120048862 +0 -124
- package/doc-builder.config.js.backup.1754120529913 +0 -124
- package/doc-builder.config.js.backup.1754218469785 +0 -124
- package/doc-builder.config.js.backup.1754384764054 +0 -124
- package/doc-builder.config.js.backup.1754567425847 +0 -124
- package/doc-builder.config.js.backup.1754568137859 +0 -126
- package/doc-builder.config.js.backup.1754569388252 +0 -126
- package/doc-builder.config.js.backup.1754576694123 +0 -126
- package/doc-builder.config.js.backup.1755031374829 +0 -126
- package/doc-builder.config.js.backup.1755034500990 +0 -126
- package/grant-access.sql +0 -15
- package/html/11.png +0 -0
- package/html/404.html +0 -115
- package/html/README.html +0 -522
- package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
- package/html/about-doc-builder.html +0 -491
- package/html/auth.js +0 -157
- package/html/claude-workflow-guide.html +0 -525
- package/html/css/notion-style.css +0 -2502
- package/html/documentation-index.html +0 -471
- package/html/guides/authentication-default-change.html +0 -370
- package/html/guides/authentication-guide.html +0 -509
- package/html/guides/cache-control-anti-pattern.html +0 -361
- package/html/guides/claude-workflow-guide.html +0 -1074
- package/html/guides/configuration-guide.html +0 -472
- package/html/guides/document-standards.html +0 -518
- package/html/guides/documentation-standards.html +0 -694
- package/html/guides/html-embedding-guide.html +0 -461
- package/html/guides/image-modal-guide.html +0 -515
- package/html/guides/next-steps-walkthrough.html +0 -638
- package/html/guides/phosphor-icons-guide.html +0 -584
- package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
- package/html/guides/private-directory-authentication.html +0 -541
- package/html/guides/public-site-deployment.html +0 -431
- package/html/guides/search-engine-verification-guide.html +0 -542
- package/html/guides/seo-guide.html +0 -661
- package/html/guides/seo-optimization-guide.html +0 -887
- package/html/guides/supabase-auth-implementation-plan.html +0 -543
- package/html/guides/supabase-auth-integration-plan.html +0 -671
- package/html/guides/supabase-auth-setup-guide.html +0 -498
- package/html/guides/supabase-authentication-complete-guide.html +0 -866
- package/html/guides/troubleshooting-guide.html +0 -633
- package/html/guides/vercel-deployment-auth-setup.html +0 -337
- package/html/guides/windows-setup-guide.html +0 -859
- package/html/image-modal-test.html +0 -318
- package/html/index.html +0 -522
- package/html/js/auth.js +0 -157
- package/html/js/main.js +0 -1747
- package/html/launch/README.html +0 -297
- package/html/launch/bubble-plugin-specification.html +0 -933
- package/html/launch/go-to-market-strategy.html +0 -663
- package/html/launch/launch-announcements.html +0 -593
- package/html/login.html +0 -102
- package/html/logout.html +0 -18
- package/html/private/cache-control-anti-pattern.html +0 -429
- package/html/private/launch/README.html +0 -371
- package/html/private/launch/auth-cleanup-summary.html +0 -361
- package/html/private/launch/bubble-plugin-specification.html +0 -1007
- package/html/private/launch/go-to-market-strategy.html +0 -737
- package/html/private/launch/launch-announcements.html +0 -667
- package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
- package/html/private/next-steps-walkthrough.html +0 -679
- package/html/private/supabase-auth-implementation-completed.html +0 -454
- package/html/private/supabase-auth-implementation-plan.html +0 -594
- package/html/private/supabase-auth-integration-plan.html +0 -704
- package/html/private/supabase-auth-setup-guide.html +0 -555
- package/html/private/test-private-doc.html +0 -302
- package/html/private/user-management-tooling.html +0 -601
- package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
- package/html/prompts/beautiful-documentation-design.html +0 -784
- package/html/prompts/markdown-document-standards.html +0 -422
- package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
- package/html/robots.txt +0 -9
- package/html/sitemap.xml +0 -357
- package/html/test-questions/how-does-it-work%3F.html +0 -294
- package/html/test-questions/step-1%3A%20getting-started.html +0 -289
- package/html/test-questions/what-is-the-purpose.html +0 -293
- package/html/test-status.html +0 -281
- package/html/vercel-cli-setup-guide.html +0 -495
- package/html/vercel-first-time-setup-guide.html +0 -454
- package/html/vercel.json +0 -29
- package/html-static/11.png +0 -0
- package/html-static/404.html +0 -115
- package/html-static/README.html +0 -599
- package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
- package/html-static/about-doc-builder.html +0 -568
- package/html-static/css/notion-style.css +0 -2502
- package/html-static/documentation-index.html +0 -548
- package/html-static/guides/authentication-default-change.html +0 -447
- package/html-static/guides/authentication-guide.html +0 -586
- package/html-static/guides/claude-workflow-guide.html +0 -1151
- package/html-static/guides/configuration-guide.html +0 -549
- package/html-static/guides/documentation-standards.html +0 -771
- package/html-static/guides/html-embedding-guide.html +0 -538
- package/html-static/guides/image-modal-guide.html +0 -592
- package/html-static/guides/phosphor-icons-guide.html +0 -661
- package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -632
- package/html-static/guides/private-directory-authentication.html +0 -618
- package/html-static/guides/public-site-deployment.html +0 -508
- package/html-static/guides/search-engine-verification-guide.html +0 -619
- package/html-static/guides/seo-guide.html +0 -738
- package/html-static/guides/seo-optimization-guide.html +0 -964
- package/html-static/guides/supabase-authentication-complete-guide.html +0 -943
- package/html-static/guides/troubleshooting-guide.html +0 -710
- package/html-static/guides/windows-setup-guide.html +0 -936
- package/html-static/image-modal-test.html +0 -395
- package/html-static/index.html +0 -599
- package/html-static/js/main.js +0 -1747
- package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
- package/html-static/prompts/beautiful-documentation-design.html +0 -861
- package/html-static/prompts/markdown-document-standards.html +0 -499
- package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -607
- package/html-static/robots.txt +0 -5
- package/html-static/sitemap.xml +0 -195
- package/html-static/test-questions/how-does-it-work%3F.html +0 -371
- package/html-static/test-questions/step-1%3A%20getting-started.html +0 -366
- package/html-static/test-questions/what-is-the-purpose.html +0 -370
- package/html-static/vercel-cli-setup-guide.html +0 -572
- package/html-static/vercel-first-time-setup-guide.html +0 -531
- package/manage-users.sql +0 -191
- package/migrate-to-domain-auth.sql +0 -47
- package/package/CACHE-BUSTING-GUIDE.md +0 -82
- package/package/CHANGELOG.md +0 -902
- package/package/README.md +0 -248
- package/package/assets/css/notion-style.css +0 -2211
- package/package/assets/js/auth.js +0 -67
- package/package/assets/js/main.js +0 -1565
- package/package/cli.js +0 -764
- package/package/index.js +0 -38
- package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
- package/package/lib/builder.js +0 -32
- package/package/lib/config.js +0 -278
- package/package/lib/core-builder.js +0 -957
- package/package/lib/deploy.js +0 -497
- package/package/lib/dev-server.js +0 -96
- package/package/package.json +0 -34
- package/package/scripts/npx-runner.js +0 -27
- package/package/scripts/setup.js +0 -56
- package/package/test-cache-bust.sh +0 -43
- package/public-config.js +0 -22
- package/public-html/404.html +0 -115
- package/public-html/README.html +0 -149
- package/public-html/css/notion-style.css +0 -2036
- package/public-html/index.html +0 -149
- package/public-html/js/auth.js +0 -67
- package/public-html/js/main.js +0 -1485
- package/quick-test-commands.md +0 -40
- package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
- package/recordings/mh-ls-22jul.txt +0 -2305
- package/screenshot.png +0 -0
- package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
- package/setup-database-v2.sql +0 -53
- package/setup-database.sql +0 -41
- package/test-auth-config.js +0 -17
- package/test-cache-bust.sh +0 -43
- package/test-docs/README.md +0 -39
- package/test-html/404.html +0 -115
- package/test-html/README.html +0 -172
- package/test-html/auth.js +0 -97
- package/test-html/css/notion-style.css +0 -2036
- package/test-html/index.html +0 -172
- package/test-html/js/auth.js +0 -97
- package/test-html/js/main.js +0 -1485
- package/test-html/login.html +0 -102
- package/test-html/logout.html +0 -18
- package/update-domain.sql +0 -9
- package/user-access-view.sql +0 -49
- package/user-management/README.md +0 -301
- package/user-management/add-users.sh +0 -776
- package/user-management/create-user.js +0 -65
- package/user-management/users.txt +0 -15
- package/view-all-users.sql +0 -40
- package/wru-auth-config.js +0 -17
|
@@ -1,584 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML. This provides...">
|
|
7
|
-
<title>Phosphor Icons Integration Guide | @knowcode/doc-builder</title>
|
|
8
|
-
|
|
9
|
-
<meta name="generator" content="@knowcode/doc-builder by Knowcode Ltd">
|
|
10
|
-
<meta name="author" content="Lindsay Smith">
|
|
11
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, icon, icons">
|
|
12
|
-
<meta name="robots" content="index, follow">
|
|
13
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html">
|
|
14
|
-
|
|
15
|
-
<!-- Open Graph / Facebook -->
|
|
16
|
-
<meta property="og:type" content="article">
|
|
17
|
-
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html">
|
|
18
|
-
<meta property="og:title" content="Phosphor Icons Integration Guide | @knowcode/doc-builder">
|
|
19
|
-
<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...">
|
|
20
|
-
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
21
|
-
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
22
|
-
<meta property="og:locale" content="en_US">
|
|
23
|
-
|
|
24
|
-
<!-- Twitter Card -->
|
|
25
|
-
<meta name="twitter:card" content="summary_large_image">
|
|
26
|
-
<meta name="twitter:site" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:creator" content="@planbbackups">
|
|
28
|
-
<meta name="twitter:title" content="Phosphor Icons Integration Guide | @knowcode/doc-builder">
|
|
29
|
-
<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...">
|
|
30
|
-
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
31
|
-
|
|
32
|
-
<!-- Custom Meta Tags -->
|
|
33
|
-
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
34
|
-
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
35
|
-
|
|
36
|
-
<!-- Fonts -->
|
|
37
|
-
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
38
|
-
|
|
39
|
-
<!-- Icons -->
|
|
40
|
-
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
41
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
42
|
-
|
|
43
|
-
<!-- Mermaid -->
|
|
44
|
-
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
45
|
-
|
|
46
|
-
<!-- Styles -->
|
|
47
|
-
<link rel="stylesheet" href="/css/notion-style.css">
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
<!-- Hide content until auth check -->
|
|
53
|
-
<style>
|
|
54
|
-
body {
|
|
55
|
-
visibility: hidden;
|
|
56
|
-
opacity: 0;
|
|
57
|
-
transition: opacity 0.3s ease;
|
|
58
|
-
}
|
|
59
|
-
body.authenticated {
|
|
60
|
-
visibility: visible;
|
|
61
|
-
opacity: 1;
|
|
62
|
-
}
|
|
63
|
-
/* Show login/logout pages immediately */
|
|
64
|
-
body.auth-page {
|
|
65
|
-
visibility: visible;
|
|
66
|
-
opacity: 1;
|
|
67
|
-
}
|
|
68
|
-
/* Style auth button consistently */
|
|
69
|
-
.auth-btn {
|
|
70
|
-
background: none;
|
|
71
|
-
border: none;
|
|
72
|
-
color: var(--text-secondary);
|
|
73
|
-
cursor: pointer;
|
|
74
|
-
padding: 0.5rem;
|
|
75
|
-
border-radius: 0.5rem;
|
|
76
|
-
transition: all 0.2s;
|
|
77
|
-
font-size: 1.1rem;
|
|
78
|
-
}
|
|
79
|
-
.auth-btn:hover {
|
|
80
|
-
background: var(--bg-secondary);
|
|
81
|
-
color: var(--text-primary);
|
|
82
|
-
}
|
|
83
|
-
</style>
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
<!-- Favicon -->
|
|
87
|
-
<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>">
|
|
88
|
-
|
|
89
|
-
<script type="application/ld+json">
|
|
90
|
-
{
|
|
91
|
-
"@context": "https://schema.org",
|
|
92
|
-
"@type": "TechArticle",
|
|
93
|
-
"headline": "Phosphor Icons Integration Guide",
|
|
94
|
-
"description": "@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML. This provides...",
|
|
95
|
-
"author": {
|
|
96
|
-
"@type": "Person",
|
|
97
|
-
"name": "Lindsay Smith"
|
|
98
|
-
},
|
|
99
|
-
"publisher": {
|
|
100
|
-
"@type": "Organization",
|
|
101
|
-
"name": "Knowcode Ltd",
|
|
102
|
-
"url": "https://knowcode.tech"
|
|
103
|
-
},
|
|
104
|
-
"datePublished": "2025-08-12T21:35:01.122Z",
|
|
105
|
-
"dateModified": "2025-08-12T21:35:01.122Z",
|
|
106
|
-
"mainEntityOfPage": {
|
|
107
|
-
"@type": "WebPage",
|
|
108
|
-
"@id": "https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html"
|
|
109
|
-
},
|
|
110
|
-
"breadcrumb": {
|
|
111
|
-
"@type": "BreadcrumbList",
|
|
112
|
-
"itemListElement": [
|
|
113
|
-
{
|
|
114
|
-
"@type": "ListItem",
|
|
115
|
-
"position": 1,
|
|
116
|
-
"name": "@knowcode/doc-builder",
|
|
117
|
-
"item": "https://doc-builder-delta.vercel.app"
|
|
118
|
-
},
|
|
119
|
-
{
|
|
120
|
-
"@type": "ListItem",
|
|
121
|
-
"position": 2,
|
|
122
|
-
"name": "Guides",
|
|
123
|
-
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
124
|
-
},
|
|
125
|
-
{
|
|
126
|
-
"@type": "ListItem",
|
|
127
|
-
"position": 3,
|
|
128
|
-
"name": "Phosphor Icons Guide",
|
|
129
|
-
"item": "https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html"
|
|
130
|
-
}
|
|
131
|
-
]
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
</script>
|
|
135
|
-
</head>
|
|
136
|
-
<body>
|
|
137
|
-
|
|
138
|
-
<!-- Header -->
|
|
139
|
-
<header class="header">
|
|
140
|
-
<div class="header-content">
|
|
141
|
-
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
142
|
-
|
|
143
|
-
<div class="header-actions">
|
|
144
|
-
<div class="deployment-info">
|
|
145
|
-
<span class="deployment-date" title="Built with doc-builder v1.9.28">Last updated: Aug 12, 2025, 09:35 PM UTC</span>
|
|
146
|
-
</div>
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
150
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
151
|
-
</a>
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
155
|
-
<i class="fas fa-moon"></i>
|
|
156
|
-
</button>
|
|
157
|
-
|
|
158
|
-
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
159
|
-
<i class="fas fa-bars"></i>
|
|
160
|
-
</button>
|
|
161
|
-
</div>
|
|
162
|
-
</div>
|
|
163
|
-
</header>
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
<!-- Breadcrumbs -->
|
|
169
|
-
<nav class="breadcrumbs " id="breadcrumbs" >
|
|
170
|
-
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
171
|
-
</nav>
|
|
172
|
-
|
|
173
|
-
<!-- Main Content -->
|
|
174
|
-
<div class="main-wrapper">
|
|
175
|
-
<!-- Sidebar -->
|
|
176
|
-
<aside class="sidebar">
|
|
177
|
-
<div class="sidebar-header">
|
|
178
|
-
<div class="filter-box">
|
|
179
|
-
<input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
|
|
180
|
-
<i class="fas fa-search filter-icon"></i>
|
|
181
|
-
</div>
|
|
182
|
-
</div>
|
|
183
|
-
<nav class="navigation">
|
|
184
|
-
|
|
185
|
-
<div class="nav-section" data-level="0">
|
|
186
|
-
<a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
|
|
187
|
-
<i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
|
|
188
|
-
</a>
|
|
189
|
-
<div class="nav-content">
|
|
190
|
-
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
|
|
191
|
-
<a href="/about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> About Doc Builder</a>
|
|
192
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Index</a>
|
|
193
|
-
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="ph ph-file-text"></i> Image Modal Test</a>
|
|
194
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Vercel Cli Setup Guide</a>
|
|
195
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel First Time Setup Guide</a></div></div>
|
|
196
|
-
<div class="nav-section" data-level="1">
|
|
197
|
-
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
198
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
|
|
199
|
-
</a>
|
|
200
|
-
<div class="nav-content" id="nav-guides-1">
|
|
201
|
-
<a href="/guides/authentication-default-change.html" class="nav-item" data-tooltip="Starting from version 1.7.4, @knowcode/doc-builder now defaults to no authentication for all documentation sites."><i class="ph ph-file-text"></i> Authentication Default Change</a>
|
|
202
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Authentication Guide</a>
|
|
203
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Claude Workflow Guide</a>
|
|
204
|
-
<a href="/guides/configuration-guide.html" class="nav-item" data-tooltip="This guide explains how @knowcode/doc-builder handles configuration files and settings."><i class="ph ph-check-circle" style="color: #059669;"></i> Configuration Guide</a>
|
|
205
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Standards</a>
|
|
206
|
-
<a href="/guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="ph ph-check-circle" style="color: #059669;"></i> Html Embedding Guide</a>
|
|
207
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Image Modal Guide</a>
|
|
208
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Phosphor Icons Guide</a>
|
|
209
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication</a>
|
|
210
|
-
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication Troubleshooting</a>
|
|
211
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Public Site Deployment</a>
|
|
212
|
-
<a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="ph ph-check-circle" style="color: #059669;"></i> Search Engine Verification Guide</a>
|
|
213
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Seo Guide</a>
|
|
214
|
-
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."><i class="ph ph-check-circle" style="color: #059669;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
|
|
215
|
-
<a href="/guides/supabase-authentication-complete-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes built-in Supabase authentication that provides enterprise-grade security with zero configuration."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Authentication Complete Guide</a>
|
|
216
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Troubleshooting Guide</a>
|
|
217
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Windows Setup Guide</a></div></div>
|
|
218
|
-
<div class="nav-section private-nav" data-level="1">
|
|
219
|
-
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
220
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-lock"></i> Private
|
|
221
|
-
</a>
|
|
222
|
-
<div class="nav-content collapsed" id="nav-private-1">
|
|
223
|
-
<a href="/private/cache-control-anti-pattern.html" class="nav-item" data-tooltip="Cache Control Anti-Pattern: Why Aggressive Cache-Busting is Bad for Documentation Sites."><i class="ph ph-check-circle" style="color: #059669;"></i> Cache Control Anti Pattern</a>
|
|
224
|
-
<a href="/private/next-steps-walkthrough.html" class="nav-item" data-tooltip="Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment."><i class="ph ph-check-circle" style="color: #059669;"></i> Next Steps Walkthrough</a>
|
|
225
|
-
<a href="/private/supabase-auth-implementation-completed.html" class="nav-item" data-tooltip="This document records the successful implementation of Supabase authentication in @knowcode/doc-builder v1.7.5+."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Completed</a>
|
|
226
|
-
<a href="/private/supabase-auth-implementation-plan.html" class="nav-item" data-tooltip="Supabase Auth Implementation Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Plan</a>
|
|
227
|
-
<a href="/private/supabase-auth-integration-plan.html" class="nav-item" data-tooltip="Supabase Authentication Integration Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Integration Plan</a>
|
|
228
|
-
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Setup Guide</a>
|
|
229
|
-
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="ph ph-file-text"></i> Test Private Doc</a>
|
|
230
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> User Management Tooling</a></div></div>
|
|
231
|
-
<div class="nav-section private-nav" data-level="2">
|
|
232
|
-
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
233
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-rocket-launch"></i> Launch
|
|
234
|
-
</a>
|
|
235
|
-
<div class="nav-content collapsed" id="nav-private-launch-2">
|
|
236
|
-
<a href="/private/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="ph ph-check-circle" style="color: #059669;"></i> Launch Overview</a>
|
|
237
|
-
<a href="/private/launch/auth-cleanup-summary.html" class="nav-item" data-tooltip="All references to the old client-side authentication system have been removed from @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Auth Cleanup Summary</a>
|
|
238
|
-
<a href="/private/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Bubble Plugin Specification</a>
|
|
239
|
-
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Go To Market Strategy</a>
|
|
240
|
-
<a href="/private/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="ph ph-check-circle" style="color: #059669;"></i> Launch Announcements</a>
|
|
241
|
-
<a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel Deployment Auth Setup</a></div></div>
|
|
242
|
-
<div class="nav-section" data-level="1">
|
|
243
|
-
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
244
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
|
|
245
|
-
</a>
|
|
246
|
-
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
247
|
-
<a href="/prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Beautiful Documentation Design</a>
|
|
248
|
-
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Markdown Document Standards</a>
|
|
249
|
-
<a href="/prompts/project-rename-strategy-sasha-publish.html" class="nav-item" data-tooltip="This document outlines the comprehensive strategy for renaming the @knowcode/doc-builder project to "sasha-publish", including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
|
|
250
|
-
<div class="nav-section" data-level="1">
|
|
251
|
-
<a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
|
|
252
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
|
|
253
|
-
</a>
|
|
254
|
-
<div class="nav-content collapsed" id="nav-test-questions-1">
|
|
255
|
-
<a href="/test-questions/how-does-it-work%3F.html" class="nav-item" data-tooltip="This is a test file to verify that question marks work properly in filenames."><i class="ph ph-file-text"></i> How Does It Work?</a>
|
|
256
|
-
<a href="/test-questions/step-1%3A%20getting-started.html" class="nav-item" data-tooltip="Step 1: Getting Started."><i class="ph ph-file-text"></i> Step 1: Getting Started</a>
|
|
257
|
-
<a href="/test-questions/what-is-the-purpose.html" class="nav-item" data-tooltip="Understanding the purpose of our documentation system"><i class="ph ph-file-text"></i> What Is The Purpose?</a></div></div>
|
|
258
|
-
</nav>
|
|
259
|
-
<div class="resize-handle"></div>
|
|
260
|
-
</aside>
|
|
261
|
-
|
|
262
|
-
<!-- Content Area -->
|
|
263
|
-
<main class="content">
|
|
264
|
-
<div class="content-inner">
|
|
265
|
-
<h1>Phosphor Icons Integration Guide</h1>
|
|
266
|
-
<h2>Overview</h2>
|
|
267
|
-
<p>@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML. This provides professional, consistent icon rendering across all platforms while keeping your markdown files readable with familiar emojis.</p>
|
|
268
|
-
<h2>How It Works</h2>
|
|
269
|
-
<h3>Automatic Conversion</h3>
|
|
270
|
-
<p>When you write emojis in your markdown:</p>
|
|
271
|
-
<pre><code class="language-markdown">✅ Task completed
|
|
272
|
-
❌ Issue found
|
|
273
|
-
🚀 Launching feature
|
|
274
|
-
</code></pre>
|
|
275
|
-
<p>They are automatically converted to Phosphor icons in HTML:</p>
|
|
276
|
-
<ul>
|
|
277
|
-
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> → Check circle icon</li>
|
|
278
|
-
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> → X circle icon </li>
|
|
279
|
-
<li><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> → Rocket launch icon</li>
|
|
280
|
-
</ul>
|
|
281
|
-
<h3>Benefits</h3>
|
|
282
|
-
<ul>
|
|
283
|
-
<li><strong>Professional appearance</strong> - Consistent icon style across your documentation</li>
|
|
284
|
-
<li><strong>Better performance</strong> - Icons load as web fonts, not Unicode characters</li>
|
|
285
|
-
<li><strong>Cross-platform consistency</strong> - Same appearance on all devices</li>
|
|
286
|
-
<li><strong>Accessibility</strong> - All icons include proper aria-labels</li>
|
|
287
|
-
<li><strong>No source changes needed</strong> - Keep using emojis in your markdown</li>
|
|
288
|
-
</ul>
|
|
289
|
-
<h2>Configuration</h2>
|
|
290
|
-
<p>Enable Phosphor Icons in your <code>doc-builder.config.js</code>:</p>
|
|
291
|
-
<pre><code class="language-javascript">module.exports = {
|
|
292
|
-
features: {
|
|
293
|
-
phosphorIcons: true, // Enable/disable icon conversion
|
|
294
|
-
phosphorWeight: 'regular', // Icon style: thin, light, regular, bold, fill, duotone
|
|
295
|
-
phosphorSize: '1.2em' // Icon size relative to text
|
|
296
|
-
}
|
|
297
|
-
};
|
|
298
|
-
</code></pre>
|
|
299
|
-
<h3>Icon Weights</h3>
|
|
300
|
-
<p>Phosphor offers different visual weights:</p>
|
|
301
|
-
<ul>
|
|
302
|
-
<li><strong>thin</strong> - Delicate, minimal style</li>
|
|
303
|
-
<li><strong>light</strong> - Subtle, refined appearance</li>
|
|
304
|
-
<li><strong>regular</strong> - Balanced, default weight (recommended)</li>
|
|
305
|
-
<li><strong>bold</strong> - Strong, prominent style</li>
|
|
306
|
-
<li><strong>fill</strong> - Solid filled icons</li>
|
|
307
|
-
<li><strong>duotone</strong> - Two-tone style with accent color</li>
|
|
308
|
-
</ul>
|
|
309
|
-
<h2>Supported Emoji Mappings</h2>
|
|
310
|
-
<h3>Status & Validation</h3>
|
|
311
|
-
<table>
|
|
312
|
-
<thead>
|
|
313
|
-
<tr>
|
|
314
|
-
<th>Emoji</th>
|
|
315
|
-
<th>Icon</th>
|
|
316
|
-
<th>Description</th>
|
|
317
|
-
</tr>
|
|
318
|
-
</thead>
|
|
319
|
-
<tbody><tr>
|
|
320
|
-
<td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i></td>
|
|
321
|
-
<td>Check circle</td>
|
|
322
|
-
<td>Success, completed, verified</td>
|
|
323
|
-
</tr>
|
|
324
|
-
<tr>
|
|
325
|
-
<td><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i></td>
|
|
326
|
-
<td>X circle</td>
|
|
327
|
-
<td>Error, failed, incorrect</td>
|
|
328
|
-
</tr>
|
|
329
|
-
<tr>
|
|
330
|
-
<td><i style="font-size: 1.2em" class="ph ph-question" aria-label="question"></i></td>
|
|
331
|
-
<td>Question mark</td>
|
|
332
|
-
<td>Unknown, uncertain</td>
|
|
333
|
-
</tr>
|
|
334
|
-
<tr>
|
|
335
|
-
<td><i style="font-size: 1.2em" class="ph ph-warning-circle" aria-label="warning"></i></td>
|
|
336
|
-
<td>Warning circle</td>
|
|
337
|
-
<td>Caution, important note</td>
|
|
338
|
-
</tr>
|
|
339
|
-
<tr>
|
|
340
|
-
<td><i style="font-size: 1.2em" class="ph ph-prohibit-inset" aria-label="not allowed"></i></td>
|
|
341
|
-
<td>Prohibit</td>
|
|
342
|
-
<td>Not allowed, forbidden</td>
|
|
343
|
-
</tr>
|
|
344
|
-
</tbody></table>
|
|
345
|
-
<h3>Development & Tech</h3>
|
|
346
|
-
<table>
|
|
347
|
-
<thead>
|
|
348
|
-
<tr>
|
|
349
|
-
<th>Emoji</th>
|
|
350
|
-
<th>Icon</th>
|
|
351
|
-
<th>Description</th>
|
|
352
|
-
</tr>
|
|
353
|
-
</thead>
|
|
354
|
-
<tbody><tr>
|
|
355
|
-
<td><i style="font-size: 1.2em" class="ph ph-laptop" aria-label="laptop"></i></td>
|
|
356
|
-
<td>Laptop</td>
|
|
357
|
-
<td>Development, coding</td>
|
|
358
|
-
</tr>
|
|
359
|
-
<tr>
|
|
360
|
-
<td><i style="font-size: 1.2em" class="ph ph-wrench" aria-label="settings"></i></td>
|
|
361
|
-
<td>Wrench</td>
|
|
362
|
-
<td>Configuration, settings</td>
|
|
363
|
-
</tr>
|
|
364
|
-
<tr>
|
|
365
|
-
<td><i style="font-size: 1.2em" class="ph ph-bug" aria-label="bug"></i></td>
|
|
366
|
-
<td>Bug</td>
|
|
367
|
-
<td>Issues, debugging</td>
|
|
368
|
-
</tr>
|
|
369
|
-
<tr>
|
|
370
|
-
<td><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i></td>
|
|
371
|
-
<td>Rocket</td>
|
|
372
|
-
<td>Launch, deploy, release</td>
|
|
373
|
-
</tr>
|
|
374
|
-
<tr>
|
|
375
|
-
<td><i style="font-size: 1.2em" class="ph ph-lightning" aria-label="fast"></i></td>
|
|
376
|
-
<td>Lightning</td>
|
|
377
|
-
<td>Performance, speed</td>
|
|
378
|
-
</tr>
|
|
379
|
-
</tbody></table>
|
|
380
|
-
<h3>Documents & Content</h3>
|
|
381
|
-
<table>
|
|
382
|
-
<thead>
|
|
383
|
-
<tr>
|
|
384
|
-
<th>Emoji</th>
|
|
385
|
-
<th>Icon</th>
|
|
386
|
-
<th>Description</th>
|
|
387
|
-
</tr>
|
|
388
|
-
</thead>
|
|
389
|
-
<tbody><tr>
|
|
390
|
-
<td><i style="font-size: 1.2em" class="ph ph-note-pencil" aria-label="edit"></i></td>
|
|
391
|
-
<td>Note pencil</td>
|
|
392
|
-
<td>Edit, write</td>
|
|
393
|
-
</tr>
|
|
394
|
-
<tr>
|
|
395
|
-
<td><i style="font-size: 1.2em" class="ph ph-books" aria-label="documentation"></i></td>
|
|
396
|
-
<td>Books</td>
|
|
397
|
-
<td>Documentation, guides</td>
|
|
398
|
-
</tr>
|
|
399
|
-
<tr>
|
|
400
|
-
<td><i style="font-size: 1.2em" class="ph ph-folder" aria-label="folder"></i></td>
|
|
401
|
-
<td>Folder</td>
|
|
402
|
-
<td>Directory, category</td>
|
|
403
|
-
</tr>
|
|
404
|
-
<tr>
|
|
405
|
-
<td><i style="font-size: 1.2em" class="ph ph-link" aria-label="link"></i></td>
|
|
406
|
-
<td>Link</td>
|
|
407
|
-
<td>URL, connection</td>
|
|
408
|
-
</tr>
|
|
409
|
-
</tbody></table>
|
|
410
|
-
<h3>Communication</h3>
|
|
411
|
-
<table>
|
|
412
|
-
<thead>
|
|
413
|
-
<tr>
|
|
414
|
-
<th>Emoji</th>
|
|
415
|
-
<th>Icon</th>
|
|
416
|
-
<th>Description</th>
|
|
417
|
-
</tr>
|
|
418
|
-
</thead>
|
|
419
|
-
<tbody><tr>
|
|
420
|
-
<td><i style="font-size: 1.2em" class="ph ph-chat-circle" aria-label="chat"></i></td>
|
|
421
|
-
<td>Chat circle</td>
|
|
422
|
-
<td>Comments, discussion</td>
|
|
423
|
-
</tr>
|
|
424
|
-
<tr>
|
|
425
|
-
<td><i style="font-size: 1.2em" class="ph ph-envelope" aria-label="email"></i></td>
|
|
426
|
-
<td>Envelope</td>
|
|
427
|
-
<td>Email, message</td>
|
|
428
|
-
</tr>
|
|
429
|
-
<tr>
|
|
430
|
-
<td><i style="font-size: 1.2em" class="ph ph-bell" aria-label="notification"></i></td>
|
|
431
|
-
<td>Bell</td>
|
|
432
|
-
<td>Notification, alert</td>
|
|
433
|
-
</tr>
|
|
434
|
-
</tbody></table>
|
|
435
|
-
<h3>Complete Mapping</h3>
|
|
436
|
-
<p>The system supports 200+ emoji-to-icon mappings covering:</p>
|
|
437
|
-
<ul>
|
|
438
|
-
<li>Status indicators</li>
|
|
439
|
-
<li>Development tools</li>
|
|
440
|
-
<li>File types</li>
|
|
441
|
-
<li>Actions</li>
|
|
442
|
-
<li>Nature elements</li>
|
|
443
|
-
<li>People & activities</li>
|
|
444
|
-
<li>Objects & symbols</li>
|
|
445
|
-
</ul>
|
|
446
|
-
<h2>Usage Examples</h2>
|
|
447
|
-
<h3>In Markdown Headers</h3>
|
|
448
|
-
<pre><code class="language-markdown">## 🚀 Getting Started
|
|
449
|
-
## 🔧 Configuration
|
|
450
|
-
## 📚 API Reference
|
|
451
|
-
## ❌ Common Errors
|
|
452
|
-
</code></pre>
|
|
453
|
-
<h3>In Lists</h3>
|
|
454
|
-
<pre><code class="language-markdown">- ✅ Feature implemented
|
|
455
|
-
- 🚧 Work in progress
|
|
456
|
-
- ❌ Deprecated
|
|
457
|
-
- 💡 Pro tip
|
|
458
|
-
</code></pre>
|
|
459
|
-
<h3>In Tables</h3>
|
|
460
|
-
<pre><code class="language-markdown">| Status | Feature | Notes |
|
|
461
|
-
|--------|---------|-------|
|
|
462
|
-
| ✅ | Search | Ready |
|
|
463
|
-
| 🚧 | Auth | In progress |
|
|
464
|
-
| ❌ | Legacy API | Deprecated |
|
|
465
|
-
</code></pre>
|
|
466
|
-
<h2>Customization</h2>
|
|
467
|
-
<h3>Custom Icon Sizes</h3>
|
|
468
|
-
<p>Override icon size for specific use cases:</p>
|
|
469
|
-
<pre><code class="language-css">/* In your custom CSS */
|
|
470
|
-
.content h1 .ph {
|
|
471
|
-
font-size: 1.5em;
|
|
472
|
-
}
|
|
473
|
-
|
|
474
|
-
.content li .ph {
|
|
475
|
-
font-size: 1.1em;
|
|
476
|
-
}
|
|
477
|
-
</code></pre>
|
|
478
|
-
<h3>Custom Icon Colors</h3>
|
|
479
|
-
<p>Icons inherit text color by default, but can be styled:</p>
|
|
480
|
-
<pre><code class="language-css">.ph-check-circle {
|
|
481
|
-
color: #10b981; /* Green for success */
|
|
482
|
-
}
|
|
483
|
-
|
|
484
|
-
.ph-x-circle {
|
|
485
|
-
color: #ef4444; /* Red for errors */
|
|
486
|
-
}
|
|
487
|
-
</code></pre>
|
|
488
|
-
<h2>Performance Considerations</h2>
|
|
489
|
-
<ul>
|
|
490
|
-
<li>Icons are loaded via CDN with long cache headers</li>
|
|
491
|
-
<li>Only the selected weight (e.g., regular) is loaded</li>
|
|
492
|
-
<li>Web font format ensures fast rendering</li>
|
|
493
|
-
<li>Approximately 300KB for a full icon set</li>
|
|
494
|
-
</ul>
|
|
495
|
-
<h2>Accessibility</h2>
|
|
496
|
-
<p>All converted icons include:</p>
|
|
497
|
-
<ul>
|
|
498
|
-
<li>Proper <code>aria-label</code> attributes</li>
|
|
499
|
-
<li>Semantic HTML (<code><i></code> tags)</li>
|
|
500
|
-
<li>Screen reader friendly descriptions</li>
|
|
501
|
-
<li>Keyboard navigation support</li>
|
|
502
|
-
</ul>
|
|
503
|
-
<h2>Troubleshooting</h2>
|
|
504
|
-
<h3>Icons Not Showing</h3>
|
|
505
|
-
<ol>
|
|
506
|
-
<li>Check if <code>phosphorIcons: true</code> in config</li>
|
|
507
|
-
<li>Verify internet connection (CDN access)</li>
|
|
508
|
-
<li>Check browser console for errors</li>
|
|
509
|
-
<li>Try clearing browser cache</li>
|
|
510
|
-
</ol>
|
|
511
|
-
<h3>Wrong Icon Weight</h3>
|
|
512
|
-
<p>Update config and rebuild:</p>
|
|
513
|
-
<pre><code class="language-javascript">features: {
|
|
514
|
-
phosphorWeight: 'bold' // Change to desired weight
|
|
515
|
-
}
|
|
516
|
-
</code></pre>
|
|
517
|
-
<h3>Emoji Not Converting</h3>
|
|
518
|
-
<ul>
|
|
519
|
-
<li>Ensure emoji is in the supported mapping list</li>
|
|
520
|
-
<li>Some complex emojis may not have icon equivalents</li>
|
|
521
|
-
<li>File an issue for missing emoji mappings</li>
|
|
522
|
-
</ul>
|
|
523
|
-
<h2>Best Practices</h2>
|
|
524
|
-
<ol>
|
|
525
|
-
<li><strong>Use semantic emojis</strong> - Choose emojis that match their purpose</li>
|
|
526
|
-
<li><strong>Be consistent</strong> - Use the same emoji for the same meaning</li>
|
|
527
|
-
<li><strong>Don't overuse</strong> - Icons should enhance, not clutter</li>
|
|
528
|
-
<li><strong>Test rendering</strong> - Preview how icons look in your docs</li>
|
|
529
|
-
<li><strong>Consider context</strong> - Some emojis work better as icons than others</li>
|
|
530
|
-
</ol>
|
|
531
|
-
<h2>Technical Details</h2>
|
|
532
|
-
<h3>Implementation</h3>
|
|
533
|
-
<ul>
|
|
534
|
-
<li>Post-processes HTML after markdown conversion</li>
|
|
535
|
-
<li>Uses regex pattern matching for efficiency</li>
|
|
536
|
-
<li>Preserves all other HTML intact</li>
|
|
537
|
-
<li>Falls back gracefully if CDN fails</li>
|
|
538
|
-
</ul>
|
|
539
|
-
<h3>Browser Support</h3>
|
|
540
|
-
<p>Phosphor Icons work in all modern browsers:</p>
|
|
541
|
-
<ul>
|
|
542
|
-
<li>Chrome/Edge 88+</li>
|
|
543
|
-
<li>Firefox 78+</li>
|
|
544
|
-
<li>Safari 14+</li>
|
|
545
|
-
<li>Mobile browsers</li>
|
|
546
|
-
</ul>
|
|
547
|
-
<h2>Future Enhancements</h2>
|
|
548
|
-
<p>Planned improvements:</p>
|
|
549
|
-
<ul>
|
|
550
|
-
<li>Custom emoji-to-icon mappings</li>
|
|
551
|
-
<li>Multiple icon libraries support</li>
|
|
552
|
-
<li>Icon search/picker tool</li>
|
|
553
|
-
<li>Animation support</li>
|
|
554
|
-
<li>SVG icon option</li>
|
|
555
|
-
</ul>
|
|
556
|
-
<h2>Resources</h2>
|
|
557
|
-
<ul>
|
|
558
|
-
<li><a href="https://phosphoricons.com/">Phosphor Icons</a> - Browse all available icons</li>
|
|
559
|
-
<li><a href="https://phosphoricons.com/?weight=regular">Icon Weights Demo</a> - Compare different weights</li>
|
|
560
|
-
<li><a href="https://github.com/phosphor-icons/web">GitHub Repository</a> - Source code and issues</li>
|
|
561
|
-
</ul>
|
|
562
|
-
<hr>
|
|
563
|
-
<p><em>This feature enhances the visual consistency of your documentation while maintaining the simplicity of writing with emojis.</em></p>
|
|
564
|
-
|
|
565
|
-
</div>
|
|
566
|
-
</main>
|
|
567
|
-
</div>
|
|
568
|
-
|
|
569
|
-
<!-- Scripts -->
|
|
570
|
-
<script>
|
|
571
|
-
// Pass configuration to frontend
|
|
572
|
-
window.docBuilderConfig = {
|
|
573
|
-
features: {
|
|
574
|
-
showPdfDownload: true,
|
|
575
|
-
menuDefaultOpen: false,
|
|
576
|
-
mermaidEnhanced: true
|
|
577
|
-
}
|
|
578
|
-
};
|
|
579
|
-
</script>
|
|
580
|
-
<script src="/js/main.js"></script>
|
|
581
|
-
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
582
|
-
<script src="/js/auth.js"></script>
|
|
583
|
-
</body>
|
|
584
|
-
</html>
|