Skip to content

Commit 423c218

Browse files
feat: Add code-function and code-keyword classes for improved styling of code elements in documentation.
1 parent 2ad7396 commit 423c218

2 files changed

Lines changed: 64 additions & 19 deletions

File tree

docs/assets/css/main.css

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -647,6 +647,43 @@ code {
647647
color: #c084fc;
648648
}
649649

650+
/* Architecture Diagram */
651+
.architecture-diagram {
652+
display: flex;
653+
flex-direction: column;
654+
align-items: center;
655+
padding: 2rem;
656+
}
657+
658+
.arch-layer {
659+
display: flex;
660+
flex-direction: column;
661+
align-items: center;
662+
}
663+
664+
.arch-box {
665+
background: linear-gradient(135deg, var(--primary-color), #8b5cf6);
666+
color: white;
667+
padding: 1rem 2rem;
668+
border-radius: 0.75rem;
669+
font-weight: 600;
670+
font-size: 1rem;
671+
text-align: center;
672+
min-width: 200px;
673+
box-shadow: 0 4px 15px rgba(59, 130, 246, 0.3);
674+
}
675+
676+
.arch-box.arch-bottom {
677+
background: linear-gradient(135deg, #06b6d4, #3b82f6);
678+
}
679+
680+
.arch-arrow {
681+
font-size: 1.5rem;
682+
color: var(--primary-color);
683+
padding: 0.5rem 0;
684+
font-weight: bold;
685+
}
686+
650687
/* Features */
651688
.features {
652689
padding: 8rem 0;

docs/documentation.html

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,22 @@ <h1 data-aos="fade-up">Documentation</h1>
5555
<h2 data-aos="fade-up">Architecture</h2>
5656
<p data-aos="fade-up">WiBLE uses a layered architecture to ensure security and reliability.</p>
5757

58-
<div class="feature-card" style="margin-top: 2rem;" data-aos="fade-up">
59-
<pre class="mermaid">
60-
graph TD
61-
App["Application Layer"] --> Core["Core Services"]
62-
Core --> Proto["Protocol Layer"]
63-
Proto --> HAL["ESP32 HAL"]
64-
</pre>
65-
<p style="margin-top: 1rem; font-size: 0.9rem; color: var(--text-muted);">* Note: Diagram simplified for
66-
web view.</p>
58+
<div class="feature-card architecture-diagram" style="margin-top: 2rem;" data-aos="fade-up">
59+
<div class="arch-layer">
60+
<div class="arch-box">Application Layer</div>
61+
<div class="arch-arrow"></div>
62+
</div>
63+
<div class="arch-layer">
64+
<div class="arch-box">Core Services</div>
65+
<div class="arch-arrow"></div>
66+
</div>
67+
<div class="arch-layer">
68+
<div class="arch-box">Protocol Layer</div>
69+
<div class="arch-arrow"></div>
70+
</div>
71+
<div class="arch-layer">
72+
<div class="arch-box arch-bottom">ESP32 HAL</div>
73+
</div>
6774
</div>
6875
</div>
6976

@@ -74,20 +81,21 @@ <h2 data-aos="fade-up">API Reference</h2>
7481
<div class="feature-card" data-aos="fade-up">
7582
<h3>WiBLE Class</h3>
7683
<ul class="check-list">
77-
<li><code>begin(config)</code>: Initialize the library</li>
78-
<li><code>startProvisioning()</code>: Start BLE advertising</li>
79-
<li><code>loop()</code>: Handle events (call in loop)</li>
80-
<li><code>isProvisioned()</code>: Check status</li>
84+
<li><code><span class="code-function">begin</span>(config)</code>: Initialize the library</li>
85+
<li><code><span class="code-function">startProvisioning</span>()</code>: Start BLE advertising
86+
</li>
87+
<li><code><span class="code-function">loop</span>()</code>: Handle events (call in loop)</li>
88+
<li><code><span class="code-function">isProvisioned</span>()</code>: Check status</li>
8189
</ul>
8290
</div>
8391

8492
<div class="feature-card" data-aos="fade-up" data-aos-delay="100">
8593
<h3>Callbacks</h3>
8694
<ul class="check-list">
87-
<li><code>onWiFiConnected(cb)</code></li>
88-
<li><code>onProvisioningComplete(cb)</code></li>
89-
<li><code>onError(cb)</code></li>
90-
<li><code>onCustomDataReceived(cb)</code></li>
95+
<li><code><span class="code-function">onWiFiConnected</span>(cb)</code></li>
96+
<li><code><span class="code-function">onProvisioningComplete</span>(cb)</code></li>
97+
<li><code><span class="code-function">onError</span>(cb)</code></li>
98+
<li><code><span class="code-function">onCustomDataReceived</span>(cb)</code></li>
9199
</ul>
92100
</div>
93101
</div>
@@ -105,11 +113,11 @@ <h2 data-aos="fade-up">Security Levels</h2>
105113
</thead>
106114
<tbody>
107115
<tr style="border-bottom: 1px solid var(--border-color);">
108-
<td style="padding: 1rem;"><code>NONE</code></td>
116+
<td style="padding: 1rem;"><code><span class="code-keyword">NONE</span></code></td>
109117
<td style="padding: 1rem;">No encryption (Development only)</td>
110118
</tr>
111119
<tr style="border-bottom: 1px solid var(--border-color);">
112-
<td style="padding: 1rem;"><code>SECURE</code></td>
120+
<td style="padding: 1rem;"><code><span class="code-keyword">SECURE</span></code></td>
113121
<td style="padding: 1rem;">ECDH Key Exchange + AES-256 (Recommended)</td>
114122
</tr>
115123
</tbody>

0 commit comments

Comments
 (0)