Skip to content

Commit ceed9d0

Browse files
committed
Merge branch 'current' into next
2 parents e31b820 + bdf8489 commit ceed9d0

File tree

12 files changed

+174
-102
lines changed

12 files changed

+174
-102
lines changed

README.md

Lines changed: 72 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -188,17 +188,6 @@ Creates a component card with an image, title, and optional description that lin
188188
189189
```
190190

191-
### `note`
192-
193-
Creates a note admonition box to highlight important information.
194-
195-
``` text
196-
{{< note >}}
197-
This is important information that the reader should pay attention to.
198-
You can include **Markdown** formatting within the note.
199-
{{< /note >}}
200-
```
201-
202191
### `seo`
203192

204193
Adds SEO metadata tags to the page for better search engine optimization and social media sharing.
@@ -207,28 +196,6 @@ Adds SEO metadata tags to the page for better search engine optimization and soc
207196
{{< seo description="Detailed guide for setting up the DHT sensor with ESPHome" image="dht-sensor.jpg" >}}
208197
```
209198

210-
### `tip`
211-
212-
Creates a tip admonition box to highlight helpful advice or best practices.
213-
214-
``` text
215-
{{< tip >}}
216-
For best results, place the sensor away from heat sources.
217-
You can include **Markdown** formatting within the tip.
218-
{{< /tip >}}
219-
```
220-
221-
### `warning`
222-
223-
Creates a warning admonition box to highlight important cautions or potential issues.
224-
225-
``` text
226-
{{< warning >}}
227-
Incorrect wiring may damage your device. Double-check connections before powering on.
228-
You can include **Markdown** formatting within the warning.
229-
{{< /warning >}}
230-
```
231-
232199
### `apiref`
233200

234201
Creates a link to a C++ API header file.
@@ -307,6 +274,78 @@ Creates a page that automatically redirects to another URL.
307274
{{< redirect url="/some/path" >}}
308275
```
309276

277+
## Markdown features
278+
279+
### `note`
280+
281+
Creates a note blockquote/alert box to highlight important information.
282+
283+
> [!NOTE]
284+
> This is important information that the reader should pay attention to.
285+
> You can include **Markdown** formatting within the block.
286+
287+
```markdown
288+
> [!NOTE]
289+
> This is important information that the reader should pay attention to.
290+
> You can include **Markdown** formatting within the block.
291+
```
292+
293+
### `important`
294+
295+
Creates an important blockquote/alert box to highlight helpful information.
296+
297+
> [!IMPORTANT]
298+
> This is helpful information that the reader should be aware of.
299+
> You can include **Markdown** formatting within the block.
300+
301+
```markdown
302+
> [!IMPORTANT]
303+
> This is helpful information that the reader should be aware of.
304+
> You can include **Markdown** formatting within the block.
305+
```
306+
307+
### `tip`
308+
309+
Creates a tip blockquote/alert box to highlight helpful advice or best practices.
310+
311+
> [!TIP]
312+
> For best results, place the sensor away from heat sources.
313+
> You can include **Markdown** formatting within the block.
314+
315+
```markdown
316+
> [!TIP]
317+
> For best results, place the sensor away from heat sources.
318+
> You can include **Markdown** formatting within the block.
319+
```
320+
321+
### `warning`
322+
323+
Creates a warning blockquote/alert box to highlight important warnings or potential issues.
324+
325+
> [!WARNING]
326+
> Incorrect wiring may damage your device. Double-check connections before powering on.
327+
> You can include **Markdown** formatting within the block.
328+
329+
```markdown
330+
> [!WARNING]
331+
> Incorrect wiring may damage your device. Double-check connections before powering on.
332+
> You can include **Markdown** formatting within the block.
333+
```
334+
335+
### `caution`
336+
337+
Creates a caution blockquote/alert box to highlight important cautions or potential issues.
338+
339+
> [!CAUTION]
340+
> Incorrect wiring may damage your device. Double-check connections before powering on.
341+
> You can include **Markdown** formatting within the block.
342+
343+
```markdown
344+
> [!CAUTION]
345+
> Incorrect wiring may damage your device. Double-check connections before powering on.
346+
> You can include **Markdown** formatting within the block.
347+
```
348+
310349
## Conversion Scripts
311350

312351
A Python script is included to help with the conversion process from RST:

content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ smart home exactly how you want it.
9191
{
9292
"icon": "bolt",
9393
"title": "Others",
94-
"description": "Realtek RTL87xx and Beken BK72xx chips are supported."
94+
"description": "Nordic Semiconductor nRF52, Realtek RTL87xx, and Beken BK72xx chips are supported."
9595
},
9696
{
9797
"icon": "computer",

content/changelog/2025.8.0.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,9 @@ long-term security and maintainability.
116116
| Container Images (Docker) | **No action needed** - Already uses Python 3.12 |
117117
| Direct Installation (pip) | **Upgrade Python to 3.11+** before updating ESPHome |
118118

119-
{{< warning >}}
120-
If you're running ESPHome directly on your machine with Python 3.10 or older, running `pip install -U esphome`
121-
will not upgrade beyond version 2025.7.x. You must upgrade your Python installation first.
122-
{{< /warning >}}
119+
> [!warning]
120+
> If you're running ESPHome directly on your machine with Python 3.10 or older, running `pip install -U esphome`
121+
> will not upgrade beyond version 2025.7.x. You must upgrade your Python installation first.
123122
124123
## Breaking Changes
125124

themes/esphome-theme/assets/css/main.css

Lines changed: 52 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,15 @@
3131
--link-accent: #007070;
3232
--component-card-bg: #fff;
3333
--component-card-text: #333;
34-
--admonition-note-bg: #e7f2fa;
35-
--admonition-note-border: #3498db;
36-
--admonition-note-title: #1080c0;
37-
--admonition-tip-bg: #e8f8e5;
38-
--admonition-tip-border: #2ecc71;
39-
--admonition-tip-title: #2ecc71;
40-
--admonition-warning-bg: #fff3cd;
41-
--admonition-warning-border: #ffcc00;
34+
35+
--blockquote-bg: #f3f6f6;
36+
--blockquote-border: var(--primary-color);
37+
38+
--alert-caution: #ff0000;
39+
--alert-important: var(--text-color);
40+
--alert-note: #5dade2;
41+
--alert-tip: #7cb342;
42+
--alert-warning: #ffcc32;
4243
}
4344

4445
[data-theme="dark"] {
@@ -60,15 +61,11 @@
6061
--link-accent: #00a5a5;
6162
--component-card-bg: #23272e;
6263
--component-card-text: #f1f1f1;
63-
--admonition-note-bg: #22313a;
64-
--admonition-note-border: #5dade2;
65-
--admonition-note-title: #5dade2;
66-
--admonition-tip-bg: #1d2a1d;
67-
--admonition-tip-border: #58d68d;
68-
--admonition-tip-title: #58d68d;
69-
--admonition-warning-bg: #23272e;
70-
--admonition-warning-border: #ffcc00;
7164
--logo-text-color: #FFFFFF;
65+
66+
--blockquote-bg: #23272e;
67+
--blockquote-border: var(--text-color);
68+
7269
}
7370

7471

@@ -926,41 +923,56 @@ summary h4.shown {
926923
display: inline;
927924
}
928925

929-
.admonition {
930-
margin: 1.5em 0;
931-
padding-top: 0.2em;
932-
padding-left: 1em;
933-
padding-right: 1em;
934-
padding-bottom: 1em;
935-
border-radius: 4px;
936-
border-left: 4px solid;
926+
927+
blockquote {
928+
border-left: .25em solid var(--blockquote-border);
929+
padding: 0.5em 1em;
930+
margin: 1em 0;
931+
background-color: var(--blockquote-bg);
937932
}
938933

939-
.admonition.note {
940-
background-color: var(--admonition-note-bg);
941-
border-color: var(--admonition-note-border);
934+
blockquote.alert-caution {
935+
border-left-color: var(--alert-caution);
942936
}
943-
.admonition.note .admonition-title {
944-
color: var(--admonition-note-title);
937+
938+
blockquote.alert-caution p.alert-heading {
939+
color: var(--alert-caution);
945940
}
946-
.admonition.tip {
947-
background-color: var(--admonition-tip-bg);
948-
border-color: var(--admonition-tip-border);
941+
942+
blockquote.alert-important {
943+
border-left-color: var(--alert-important);
944+
}
945+
946+
blockquote.alert-important p.alert-heading {
947+
color: var(--alert-important);
949948
}
950-
.admonition.tip .admonition-title {
951-
color: var(--admonition-tip-title);
949+
950+
blockquote.alert-note {
951+
border-left-color: var(--alert-note);
952+
}
953+
954+
blockquote.alert-note p.alert-heading {
955+
color: var(--alert-note);
952956
}
953957

954-
.admonition.warning, .admonition.caution, .admonition.important {
955-
background-color: var(--admonition-warning-bg);
956-
border-color: #e67e22;
958+
blockquote.alert-tip {
959+
border-left-color: var(--alert-tip);
957960
}
958961

959-
.admonition.warning, .admonition.caution, .admonition.important .admonition-title {
960-
color: #e67e22;
962+
blockquote.alert-tip p.alert-heading {
963+
color: var(--alert-tip);
961964
}
962965

963-
.admonition-title {
966+
blockquote.alert-warning {
967+
border-left-color: var(--alert-warning);
968+
}
969+
970+
blockquote.alert-warning p.alert-heading {
971+
color: var(--alert-warning);
972+
}
973+
974+
975+
.alert p.alert-heading {
964976
font-weight: bold;
965977
margin: 0.5em 0;
966978
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{{ $emojis := dict
2+
"caution" ":exclamation:"
3+
"important" ":information_source:"
4+
"note" ":information_source:"
5+
"tip" ":white_check_mark:"
6+
"warning" ":warning:"
7+
}}
8+
9+
<blockquote class="alert alert-{{ .AlertType }}">
10+
<p class="alert-heading">
11+
{{ transform.Emojify (index $emojis .AlertType) }}
12+
{{ with .AlertTitle }}
13+
{{ . }}
14+
{{ else }}
15+
{{ or (i18n .AlertType) (title .AlertType) }}
16+
{{ end }}
17+
</p>
18+
{{ .Text }}
19+
</blockquote>
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<blockquote>
2+
{{ .Text }}
3+
</blockquote>

themes/esphome-theme/layouts/_default/projects.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,13 @@ <h1>{{ .Title }}</h1>
115115
src="https://unpkg.com/esp-web-tools@10/dist/web/install-button.js?module"
116116
></script>
117117

118-
<div class="admonition note unsupported hidden">
119-
<p class="admonition-title">Note</p>
118+
<blockquote class="alert alert-warning unsupported hidden">
119+
<p class="alert-heading">⚠️ Warning</p>
120120
<p>
121121
This page requires a browser that supports WebSerial. Please open this
122122
website on your desktop using Google Chrome or Microsoft Edge.
123123
</p>
124-
</div>
124+
</blockquote>
125125

126126
<div class="question-prompt">I want to create a:</div>
127127
<div class="types">
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{{/*
22
CAUTION SHORTCODE
3-
Creates a caution admonition box to highlight important cautions or potential issues.
3+
Creates a caution alert/callout box to highlight important cautions or potential issues.
44

55
Usage:
66
{{< caution >}}
@@ -11,7 +11,7 @@
1111
Content:
1212
The content between the opening and closing shortcode tags will be displayed inside the caution box.
1313
*/}}
14-
<div class="admonition caution">
15-
<p class="admonition-title">Caution</p>
14+
<blockquote class="alert alert-caution">
15+
<p class="alert-heading">{{ transform.Emojify ":exclamation:" }} Caution</p>
1616
{{ .Inner | .Page.RenderString}}
17-
</div>
17+
</blockquote>
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{{/*
22
Important SHORTCODE
3-
Creates an "important" admonition box to highlight important cautions or potential issues.
3+
Creates an "important" alert/callout box to highlight important cautions or potential issues.
44

55
Usage:
66
{{< important >}}
@@ -11,7 +11,7 @@
1111
Content:
1212
The content between the opening and closing shortcode tags will be displayed inside the block.
1313
*/}}
14-
<div class="admonition important">
15-
<p class="admonition-title">Important</p>
16-
{{ .Inner | .Page.RenderString}}
17-
</div>
14+
<blockquote class="alert alert-important">
15+
<p class="alert-heading">{{ transform.Emojify ":information_source:" }} Important</p>
16+
{{ .Inner | .Page.RenderString }}
17+
</blockquote>
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{{/*
22
NOTE SHORTCODE
3-
Creates a note admonition box to highlight important information.
3+
Creates a note alert/callout box to highlight important information.
44

55
Usage:
66
{{< note >}}
@@ -11,7 +11,7 @@
1111
Content:
1212
The content between the opening and closing shortcode tags will be displayed inside the note box.
1313
*/}}
14-
<div class="admonition note">
15-
<p class="admonition-title">Note</p>
14+
<blockquote class="alert alert-note">
15+
<p class="alert-heading">{{ transform.Emojify ":information_source:" }} Note</p>
1616
{{ .Inner | .Page.RenderString }}
17-
</div>
17+
</blockquote>

0 commit comments

Comments
 (0)