@knowcode/doc-builder 1.9.19 → 1.9.21
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/cli.js +15 -1
- package/doc-builder.config.js +4 -2
- package/doc-builder.config.js.backup.1754384764054 +124 -0
- package/doc-builder.config.js.backup.1754567425847 +124 -0
- package/html/README.html +12 -4
- package/html/about-doc-builder.html +12 -4
- package/html/documentation-index.html +12 -4
- package/html/guides/authentication-default-change.html +12 -4
- package/html/guides/authentication-guide.html +12 -4
- package/html/guides/claude-workflow-guide.html +12 -4
- package/html/guides/configuration-guide.html +12 -4
- package/html/guides/documentation-standards.html +12 -4
- package/html/guides/html-embedding-guide.html +12 -4
- package/html/guides/image-modal-guide.html +12 -4
- package/html/guides/phosphor-icons-guide.html +12 -4
- package/html/guides/private-directory-authentication-troubleshooting.html +12 -4
- package/html/guides/private-directory-authentication.html +12 -4
- package/html/guides/public-site-deployment.html +12 -4
- package/html/guides/search-engine-verification-guide.html +12 -4
- package/html/guides/seo-guide.html +12 -4
- package/html/guides/seo-optimization-guide.html +12 -4
- package/html/guides/supabase-authentication-complete-guide.html +12 -4
- package/html/guides/troubleshooting-guide.html +12 -4
- package/html/guides/windows-setup-guide.html +12 -4
- package/html/image-modal-test.html +12 -4
- package/html/index.html +12 -4
- package/html/private/cache-control-anti-pattern.html +12 -4
- package/html/private/launch/README.html +12 -4
- package/html/private/launch/auth-cleanup-summary.html +12 -4
- package/html/private/launch/bubble-plugin-specification.html +12 -4
- package/html/private/launch/go-to-market-strategy.html +12 -4
- package/html/private/launch/launch-announcements.html +12 -4
- package/html/private/launch/vercel-deployment-auth-setup.html +12 -4
- package/html/private/next-steps-walkthrough.html +12 -4
- package/html/private/supabase-auth-implementation-completed.html +12 -4
- package/html/private/supabase-auth-implementation-plan.html +12 -4
- package/html/private/supabase-auth-integration-plan.html +12 -4
- package/html/private/supabase-auth-setup-guide.html +12 -4
- package/html/private/test-private-doc.html +12 -4
- package/html/private/user-management-tooling.html +12 -4
- package/html/prompts/beautiful-documentation-design.html +12 -4
- package/html/prompts/markdown-document-standards.html +12 -4
- package/html/prompts/project-rename-strategy-sasha-publish.html +12 -4
- package/html/sitemap.xml +74 -56
- package/html/test-questions/how-does-it-work%3F.html +290 -0
- package/html/test-questions/step-1%3A%20getting-started.html +285 -0
- package/html/test-questions/what-is-the-purpose.html +289 -0
- package/html/vercel-cli-setup-guide.html +12 -4
- package/html/vercel-first-time-setup-guide.html +12 -4
- package/html-static/404.html +115 -0
- package/html-static/README.html +456 -0
- package/html-static/about-doc-builder.html +425 -0
- package/html-static/css/notion-style.css +2426 -0
- package/html-static/documentation-index.html +405 -0
- package/html-static/guides/authentication-default-change.html +304 -0
- package/html-static/guides/authentication-guide.html +443 -0
- package/html-static/guides/claude-workflow-guide.html +1008 -0
- package/html-static/guides/configuration-guide.html +406 -0
- package/html-static/guides/documentation-standards.html +628 -0
- package/html-static/guides/html-embedding-guide.html +395 -0
- package/html-static/guides/image-modal-guide.html +449 -0
- package/html-static/guides/phosphor-icons-guide.html +518 -0
- package/html-static/guides/private-directory-authentication-troubleshooting.html +489 -0
- package/html-static/guides/private-directory-authentication.html +475 -0
- package/html-static/guides/public-site-deployment.html +365 -0
- package/html-static/guides/search-engine-verification-guide.html +476 -0
- package/html-static/guides/seo-guide.html +595 -0
- package/html-static/guides/seo-optimization-guide.html +821 -0
- package/html-static/guides/supabase-authentication-complete-guide.html +800 -0
- package/html-static/guides/troubleshooting-guide.html +567 -0
- package/html-static/guides/windows-setup-guide.html +793 -0
- package/html-static/image-modal-test.html +252 -0
- package/html-static/index.html +456 -0
- package/html-static/js/main.js +1692 -0
- package/html-static/prompts/beautiful-documentation-design.html +718 -0
- package/html-static/prompts/markdown-document-standards.html +356 -0
- package/html-static/prompts/project-rename-strategy-sasha-publish.html +464 -0
- package/html-static/robots.txt +5 -0
- package/html-static/sitemap.xml +189 -0
- package/html-static/test-questions/how-does-it-work%3F.html +228 -0
- package/html-static/test-questions/step-1%3A%20getting-started.html +223 -0
- package/html-static/test-questions/what-is-the-purpose.html +227 -0
- package/html-static/vercel-cli-setup-guide.html +429 -0
- package/html-static/vercel-first-time-setup-guide.html +388 -0
- package/lib/config.js +9 -2
- package/lib/core-builder.js +167 -6
- package/package.json +1 -1
|
@@ -0,0 +1,449 @@
|
|
|
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="The @knowcode/doc-builder includes a powerful image modal system that automatically transforms all images in your documentation into clickable, full-screen...">
|
|
7
|
+
<title>Image Modal 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, images, modal">
|
|
12
|
+
<meta name="robots" content="index, follow">
|
|
13
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/image-modal-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/image-modal-guide.html">
|
|
18
|
+
<meta property="og:title" content="Image Modal Guide | @knowcode/doc-builder">
|
|
19
|
+
<meta property="og:description" content="The @knowcode/doc-builder includes a powerful image modal system that automatically transforms all images in your documentation into clickable, full-screen...">
|
|
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="Image Modal Guide | @knowcode/doc-builder">
|
|
29
|
+
<meta name="twitter:description" content="The @knowcode/doc-builder includes a powerful image modal system that automatically transforms all images in your documentation into clickable, full-screen...">
|
|
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
|
+
<!-- Favicon -->
|
|
52
|
+
<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>">
|
|
53
|
+
|
|
54
|
+
<script type="application/ld+json">
|
|
55
|
+
{
|
|
56
|
+
"@context": "https://schema.org",
|
|
57
|
+
"@type": "TechArticle",
|
|
58
|
+
"headline": "Image Modal Guide",
|
|
59
|
+
"description": "The @knowcode/doc-builder includes a powerful image modal system that automatically transforms all images in your documentation into clickable, full-screen...",
|
|
60
|
+
"author": {
|
|
61
|
+
"@type": "Person",
|
|
62
|
+
"name": "Lindsay Smith"
|
|
63
|
+
},
|
|
64
|
+
"publisher": {
|
|
65
|
+
"@type": "Organization",
|
|
66
|
+
"name": "Knowcode Ltd",
|
|
67
|
+
"url": "https://knowcode.tech"
|
|
68
|
+
},
|
|
69
|
+
"datePublished": "2025-08-07T11:50:26.075Z",
|
|
70
|
+
"dateModified": "2025-08-07T11:50:26.075Z",
|
|
71
|
+
"mainEntityOfPage": {
|
|
72
|
+
"@type": "WebPage",
|
|
73
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/image-modal-guide.html"
|
|
74
|
+
},
|
|
75
|
+
"breadcrumb": {
|
|
76
|
+
"@type": "BreadcrumbList",
|
|
77
|
+
"itemListElement": [
|
|
78
|
+
{
|
|
79
|
+
"@type": "ListItem",
|
|
80
|
+
"position": 1,
|
|
81
|
+
"name": "@knowcode/doc-builder",
|
|
82
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"@type": "ListItem",
|
|
86
|
+
"position": 2,
|
|
87
|
+
"name": "Guides",
|
|
88
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"@type": "ListItem",
|
|
92
|
+
"position": 3,
|
|
93
|
+
"name": "Image Modal Guide",
|
|
94
|
+
"item": "https://doc-builder-delta.vercel.app/guides/image-modal-guide.html"
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
</script>
|
|
100
|
+
</head>
|
|
101
|
+
<body>
|
|
102
|
+
<!-- Header -->
|
|
103
|
+
<header class="header">
|
|
104
|
+
<div class="header-content">
|
|
105
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
106
|
+
|
|
107
|
+
<div class="header-actions">
|
|
108
|
+
<div class="deployment-info">
|
|
109
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.20">Last updated: Aug 7, 2025, 11:50 AM UTC</span>
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
115
|
+
<i class="fas fa-moon"></i>
|
|
116
|
+
</button>
|
|
117
|
+
|
|
118
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
119
|
+
<i class="fas fa-bars"></i>
|
|
120
|
+
</button>
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
</header>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
<!-- Breadcrumbs -->
|
|
128
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
129
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
130
|
+
</nav>
|
|
131
|
+
|
|
132
|
+
<!-- Main Content -->
|
|
133
|
+
<div class="main-wrapper">
|
|
134
|
+
<!-- Sidebar -->
|
|
135
|
+
<aside class="sidebar">
|
|
136
|
+
<div class="sidebar-header">
|
|
137
|
+
<div class="filter-box">
|
|
138
|
+
<input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
|
|
139
|
+
<i class="fas fa-search filter-icon"></i>
|
|
140
|
+
</div>
|
|
141
|
+
</div>
|
|
142
|
+
<nav class="navigation">
|
|
143
|
+
|
|
144
|
+
<div class="nav-section" data-level="0">
|
|
145
|
+
<a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
|
|
146
|
+
<i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
|
|
147
|
+
</a>
|
|
148
|
+
<div class="nav-content">
|
|
149
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
|
|
150
|
+
<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>
|
|
151
|
+
<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>
|
|
152
|
+
<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>
|
|
153
|
+
<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>
|
|
154
|
+
<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>
|
|
155
|
+
<div class="nav-section" data-level="1">
|
|
156
|
+
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
157
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
|
|
158
|
+
</a>
|
|
159
|
+
<div class="nav-content" id="nav-guides-1">
|
|
160
|
+
<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>
|
|
161
|
+
<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>
|
|
162
|
+
<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>
|
|
163
|
+
<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>
|
|
164
|
+
<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>
|
|
165
|
+
<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>
|
|
166
|
+
<a href="/guides/image-modal-guide.html" class="nav-item active" 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>
|
|
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="ph ph-pencil-simple" style="color: #d97706;"></i> Phosphor Icons Guide</a>
|
|
168
|
+
<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>
|
|
169
|
+
<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>
|
|
170
|
+
<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>
|
|
171
|
+
<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>
|
|
172
|
+
<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>
|
|
173
|
+
<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>
|
|
174
|
+
<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>
|
|
175
|
+
<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>
|
|
176
|
+
<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>
|
|
177
|
+
<div class="nav-section" data-level="1">
|
|
178
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
179
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
|
|
180
|
+
</a>
|
|
181
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
182
|
+
<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>
|
|
183
|
+
<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>
|
|
184
|
+
<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>
|
|
185
|
+
<div class="nav-section" data-level="1">
|
|
186
|
+
<a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
|
|
187
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
|
|
188
|
+
</a>
|
|
189
|
+
<div class="nav-content collapsed" id="nav-test-questions-1">
|
|
190
|
+
<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>
|
|
191
|
+
<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>
|
|
192
|
+
<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>
|
|
193
|
+
</nav>
|
|
194
|
+
<div class="resize-handle"></div>
|
|
195
|
+
</aside>
|
|
196
|
+
|
|
197
|
+
<!-- Content Area -->
|
|
198
|
+
<main class="content">
|
|
199
|
+
<div class="content-inner">
|
|
200
|
+
<h1>Image Modal Guide</h1>
|
|
201
|
+
<p>The @knowcode/doc-builder includes a powerful image modal system that automatically transforms all images in your documentation into clickable, full-screen experiences.</p>
|
|
202
|
+
<h2>Overview</h2>
|
|
203
|
+
<p>When users click on any image in your generated documentation, it opens in a professional modal overlay with:</p>
|
|
204
|
+
<ul>
|
|
205
|
+
<li>Full-screen viewing experience</li>
|
|
206
|
+
<li>Smooth animations and transitions</li>
|
|
207
|
+
<li>Multiple close methods</li>
|
|
208
|
+
<li>Alt text displayed as captions</li>
|
|
209
|
+
<li>Responsive design for all devices</li>
|
|
210
|
+
<li>Dark theme support</li>
|
|
211
|
+
</ul>
|
|
212
|
+
<h2>Features</h2>
|
|
213
|
+
<h3>Automatic Enhancement</h3>
|
|
214
|
+
<ul>
|
|
215
|
+
<li><strong>Zero Configuration</strong>: All content images automatically become clickable</li>
|
|
216
|
+
<li><strong>Hover Effects</strong>: Images show subtle hover animations to indicate they're interactive</li>
|
|
217
|
+
<li><strong>Professional Styling</strong>: Rounded corners, shadows, and smooth transitions</li>
|
|
218
|
+
</ul>
|
|
219
|
+
<h3>Modal Experience</h3>
|
|
220
|
+
<ul>
|
|
221
|
+
<li><strong>Full-Screen Display</strong>: Images scale to fit the screen while maintaining aspect ratio</li>
|
|
222
|
+
<li><strong>Professional Overlay</strong>: Dark backdrop with blur effects</li>
|
|
223
|
+
<li><strong>Caption Support</strong>: Alt text appears as captions below the modal image</li>
|
|
224
|
+
<li><strong>Responsive Design</strong>: Optimized for desktop, tablet, and mobile devices</li>
|
|
225
|
+
</ul>
|
|
226
|
+
<h3>Accessibility</h3>
|
|
227
|
+
<ul>
|
|
228
|
+
<li><strong>Keyboard Navigation</strong>: Press Escape to close the modal</li>
|
|
229
|
+
<li><strong>Multiple Close Methods</strong>: Click X button, click outside image, or press Escape</li>
|
|
230
|
+
<li><strong>Alt Text Integration</strong>: Screen readers can access image descriptions</li>
|
|
231
|
+
<li><strong>Focus Management</strong>: Proper focus handling when modal opens/closes</li>
|
|
232
|
+
</ul>
|
|
233
|
+
<h2>How to Use</h2>
|
|
234
|
+
<h3>Basic Usage</h3>
|
|
235
|
+
<p>Simply include images in your markdown files as normal:</p>
|
|
236
|
+
<pre><code class="language-markdown">
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
</code></pre>
|
|
240
|
+
<h3>Best Practices for Alt Text</h3>
|
|
241
|
+
<p>Since alt text becomes the modal caption, write descriptive, meaningful descriptions:</p>
|
|
242
|
+
<p><strong><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Good Alt Text:</strong></p>
|
|
243
|
+
<pre><code class="language-markdown">
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
</code></pre>
|
|
249
|
+
<p><strong><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Poor Alt Text:</strong></p>
|
|
250
|
+
<pre><code class="language-markdown">
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</code></pre>
|
|
254
|
+
<h3>Image Organization</h3>
|
|
255
|
+
<p>Organize your images in dedicated folders for better maintenance:</p>
|
|
256
|
+
<pre><code>docs/
|
|
257
|
+
├── images/
|
|
258
|
+
│ ├── screenshots/
|
|
259
|
+
│ │ ├── dashboard.png
|
|
260
|
+
│ │ └── settings.png
|
|
261
|
+
│ └── diagrams/
|
|
262
|
+
│ ├── architecture.svg
|
|
263
|
+
│ └── workflow.png
|
|
264
|
+
└── guides/
|
|
265
|
+
└── setup-guide.md
|
|
266
|
+
</code></pre>
|
|
267
|
+
<p>Then reference them in your markdown:</p>
|
|
268
|
+
<pre><code class="language-markdown">
|
|
269
|
+
</code></pre>
|
|
270
|
+
<h2>Styling and Theming</h2>
|
|
271
|
+
<h3>CSS Customization</h3>
|
|
272
|
+
<p>The modal system uses CSS variables that you can customize:</p>
|
|
273
|
+
<pre><code class="language-css">:root {
|
|
274
|
+
/* Modal overlay background */
|
|
275
|
+
--color-bg-overlay: rgba(0, 0, 0, 0.9);
|
|
276
|
+
|
|
277
|
+
/* Animation timing */
|
|
278
|
+
--duration-normal: 0.3s;
|
|
279
|
+
--easing-out: cubic-bezier(0.16, 1, 0.3, 1);
|
|
280
|
+
|
|
281
|
+
/* Border radius for modal image */
|
|
282
|
+
--radius-lg: 12px;
|
|
283
|
+
}
|
|
284
|
+
</code></pre>
|
|
285
|
+
<h3>Dark Theme Support</h3>
|
|
286
|
+
<p>The modal automatically adapts to dark theme:</p>
|
|
287
|
+
<ul>
|
|
288
|
+
<li>Darker overlay background</li>
|
|
289
|
+
<li>Adjusted close button styling</li>
|
|
290
|
+
<li>Proper contrast for captions</li>
|
|
291
|
+
</ul>
|
|
292
|
+
<h2>Technical Implementation</h2>
|
|
293
|
+
<h3>Automatic Initialization</h3>
|
|
294
|
+
<p>The modal system initializes automatically when the page loads:</p>
|
|
295
|
+
<pre><code class="language-javascript">// Automatically called on DOM ready
|
|
296
|
+
initImageModal();
|
|
297
|
+
</code></pre>
|
|
298
|
+
<h3>Event Handling</h3>
|
|
299
|
+
<p>The system uses efficient event delegation:</p>
|
|
300
|
+
<ul>
|
|
301
|
+
<li>Single event listener on the document</li>
|
|
302
|
+
<li>Dynamically handles all current and future images</li>
|
|
303
|
+
<li>Proper cleanup when modal closes</li>
|
|
304
|
+
</ul>
|
|
305
|
+
<h3>Performance Optimizations</h3>
|
|
306
|
+
<ul>
|
|
307
|
+
<li><strong>CSS-First Approach</strong>: Minimal JavaScript for better performance</li>
|
|
308
|
+
<li><strong>Event Delegation</strong>: Efficient handling of multiple images</li>
|
|
309
|
+
<li><strong>Smooth Animations</strong>: Hardware-accelerated CSS transitions</li>
|
|
310
|
+
<li><strong>Memory Management</strong>: Proper event cleanup</li>
|
|
311
|
+
</ul>
|
|
312
|
+
<h2>Supported Image Formats</h2>
|
|
313
|
+
<p>The modal works with all web-compatible image formats:</p>
|
|
314
|
+
<ul>
|
|
315
|
+
<li><strong>Raster Images</strong>: PNG, JPG, JPEG, GIF, WEBP</li>
|
|
316
|
+
<li><strong>Vector Images</strong>: SVG</li>
|
|
317
|
+
<li><strong>Animated Images</strong>: Animated GIFs, WEBP animations</li>
|
|
318
|
+
</ul>
|
|
319
|
+
<h2>Mobile Experience</h2>
|
|
320
|
+
<h3>Touch-Friendly Interface</h3>
|
|
321
|
+
<ul>
|
|
322
|
+
<li><strong>Large Close Button</strong>: Easy to tap on mobile devices</li>
|
|
323
|
+
<li><strong>Gesture Support</strong>: Tap outside image to close</li>
|
|
324
|
+
<li><strong>Responsive Sizing</strong>: Images scale appropriately for screen size</li>
|
|
325
|
+
<li><strong>Optimized Layout</strong>: Adjusted button and caption sizes for mobile</li>
|
|
326
|
+
</ul>
|
|
327
|
+
<h3>Performance on Mobile</h3>
|
|
328
|
+
<ul>
|
|
329
|
+
<li><strong>Lightweight Implementation</strong>: Minimal impact on mobile performance</li>
|
|
330
|
+
<li><strong>Touch Optimizations</strong>: Proper touch event handling</li>
|
|
331
|
+
<li><strong>Viewport Considerations</strong>: Respects device viewport settings</li>
|
|
332
|
+
</ul>
|
|
333
|
+
<h2>Examples</h2>
|
|
334
|
+
<h3>Documentation Screenshots</h3>
|
|
335
|
+
<pre><code class="language-markdown"># Setup Guide
|
|
336
|
+
|
|
337
|
+
Follow these steps to configure your application:
|
|
338
|
+
|
|
339
|
+
1. **Access Settings**
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
2. **Configure API Keys**
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
3. **Save and Deploy**
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
</code></pre>
|
|
351
|
+
<h3>Technical Diagrams</h3>
|
|
352
|
+
<pre><code class="language-markdown"># System Architecture
|
|
353
|
+
|
|
354
|
+
Our system follows a microservices architecture:
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
The authentication flow works as follows:
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
</code></pre>
|
|
362
|
+
<h3>Before/After Comparisons</h3>
|
|
363
|
+
<pre><code class="language-markdown"># UI Improvements
|
|
364
|
+
|
|
365
|
+
We've redesigned the dashboard for better usability:
|
|
366
|
+
|
|
367
|
+
**Before:**
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
**After:**
|
|
371
|
+
|
|
372
|
+
</code></pre>
|
|
373
|
+
<h2>Troubleshooting</h2>
|
|
374
|
+
<h3>Images Not Clickable</h3>
|
|
375
|
+
<p><strong>Problem</strong>: Images don't show hover effects or modal<br><strong>Solution</strong>: Ensure images are within content areas with the <code>.content</code> class</p>
|
|
376
|
+
<h3>Modal Not Opening</h3>
|
|
377
|
+
<p><strong>Problem</strong>: Clicking images doesn't open modal<br><strong>Solution</strong>: Check that main.js is properly loaded and no JavaScript errors exist</p>
|
|
378
|
+
<h3>Caption Not Showing</h3>
|
|
379
|
+
<p><strong>Problem</strong>: Alt text doesn't appear as caption<br><strong>Solution</strong>: Verify alt text is present in the markdown image syntax</p>
|
|
380
|
+
<h3>Styling Issues</h3>
|
|
381
|
+
<p><strong>Problem</strong>: Modal appears broken or unstyled<br><strong>Solution</strong>: Ensure notion-style.css is properly loaded</p>
|
|
382
|
+
<h2>Advanced Usage</h2>
|
|
383
|
+
<h3>Custom Image Classes</h3>
|
|
384
|
+
<p>Add custom classes to images for special styling:</p>
|
|
385
|
+
<pre><code class="language-markdown">![Large hero image of the product dashboard](){.hero-image}
|
|
386
|
+
</code></pre>
|
|
387
|
+
<h3>Image Galleries</h3>
|
|
388
|
+
<p>Create image galleries with multiple related images:</p>
|
|
389
|
+
<pre><code class="language-markdown">## Product Screenshots
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
</code></pre>
|
|
396
|
+
<h2>Integration with Other Features</h2>
|
|
397
|
+
<h3>Mermaid Diagrams</h3>
|
|
398
|
+
<p>Mermaid diagrams can also benefit from the modal system when exported as images:</p>
|
|
399
|
+
<pre><code class="language-markdown"><div class="mermaid-wrapper">
|
|
400
|
+
<div class="mermaid">graph TD
|
|
401
|
+
A[User Request] --> B{Authentication}
|
|
402
|
+
B -->|Valid| C[Process Request]
|
|
403
|
+
B -->|Invalid| D[Return Error]
|
|
404
|
+
C --> E[Return Response]</div>
|
|
405
|
+
</div>
|
|
406
|
+
|
|
407
|
+
### PDF Export
|
|
408
|
+
|
|
409
|
+
When using PDF export features, images maintain their quality and alt text information.
|
|
410
|
+
|
|
411
|
+
### Search Integration
|
|
412
|
+
|
|
413
|
+
Alt text content is indexed for search functionality, making images discoverable.
|
|
414
|
+
|
|
415
|
+
## Best Practices Summary
|
|
416
|
+
|
|
417
|
+
1. **Write Descriptive Alt Text**: Use meaningful descriptions that work as captions
|
|
418
|
+
2. **Organize Images**: Keep images in dedicated folders with logical structure
|
|
419
|
+
3. **Optimize File Sizes**: Use appropriate image compression for web delivery
|
|
420
|
+
4. **Consider Accessibility**: Ensure alt text provides value for screen readers
|
|
421
|
+
5. **Test Responsiveness**: Verify images work well on different device sizes
|
|
422
|
+
6. **Use Appropriate Formats**: Choose the right image format for your content type
|
|
423
|
+
|
|
424
|
+
## Conclusion
|
|
425
|
+
|
|
426
|
+
The image modal system in @knowcode/doc-builder provides a professional, accessible way to showcase images in your documentation. With zero configuration required, it automatically enhances the user experience while maintaining excellent performance and accessibility standards.
|
|
427
|
+
|
|
428
|
+
For more advanced customization options or troubleshooting, refer to the main documentation or reach out to the community for support.
|
|
429
|
+
</code></pre>
|
|
430
|
+
|
|
431
|
+
</div>
|
|
432
|
+
</main>
|
|
433
|
+
</div>
|
|
434
|
+
|
|
435
|
+
<!-- Scripts -->
|
|
436
|
+
<script>
|
|
437
|
+
// Pass configuration to frontend
|
|
438
|
+
window.docBuilderConfig = {
|
|
439
|
+
features: {
|
|
440
|
+
showPdfDownload: true,
|
|
441
|
+
menuDefaultOpen: false,
|
|
442
|
+
mermaidEnhanced: true
|
|
443
|
+
}
|
|
444
|
+
};
|
|
445
|
+
</script>
|
|
446
|
+
<script src="/js/main.js"></script>
|
|
447
|
+
|
|
448
|
+
</body>
|
|
449
|
+
</html>
|