Skip to content

Commit 9ebb6fc

Browse files
SieboldianusSieboldianus
committed
feat: add admonition shortcodes for tip, warning and note
1 parent 3f6a71f commit 9ebb6fc

9 files changed

Lines changed: 86 additions & 0 deletions

File tree

‎assets/scss/_admonition.scss‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
/*admonition styles */
2+
3+
.admonition-icon {
4+
fill: $text;
5+
width: 20px;
6+
margin: 6px;
7+
margin-left: -27px;
8+
position: absolute;
9+
top: 10px;
10+
}
11+
12+
13+
.note {
14+
border-left-width: 35px;
15+
border-left-style: solid;
16+
position: relative;
17+
border-color: $admonition-note;
18+
display: block;
19+
}
20+
21+
.warning {
22+
border-left-width: 35px;
23+
border-left-style: solid;
24+
position: relative;
25+
border-color: $admonition-warning;
26+
display: block;
27+
}
28+
29+
.tip {
30+
border-left-width: 35px;
31+
border-left-style: solid;
32+
position: relative;
33+
border-color: $admonition-tip;
34+
display: block;
35+
}
36+
37+
.admonition-content {
38+
display: block;
39+
margin: 0px;
40+
padding: .125em 1em;
41+
margin-top: 2em;
42+
margin-bottom: 2em;
43+
overflow-x: auto;
44+
background-color: $highlight-grey;
45+
}

‎assets/scss/_predefined.scss‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ $light-grey: #494f5c;
66
$dark-grey: #3B3E48;
77
$highlight-grey: #7d828a;
88
$midnightblue: #2c3e50;
9+
$admonition-note :#F8E45C;
10+
$admonition-tip : #0594CB;
11+
$admonition-warning :#ff725c;
912

1013
// Fonts
1114
//

‎assets/scss/style.scss‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
@import "normalize.scss";
33
@import "syntax.scss";
44
@import "animate.scss";
5+
@import "admonition.scss";
56

67
/* Webkit Scrollbar Customize */
78
::-webkit-scrollbar {

‎layouts/partials/svg/exclamation.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎layouts/partials/svg/lightbulb.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎layouts/partials/svg/sticky-note.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎layouts/shortcodes/note.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{{ $_hugo_config := `{ "version": 1 }` }}
2+
3+
<aside class="admonition note">
4+
<!-- <h2 id="{{if .Get 0}}{{.Get 0 | urlize}}{{else}}note{{end}}">{{if .Get 0}}{{.Get 0 | markdownify}}{{else}}Note{{end}}</h2> -->
5+
<!-- <h3>Note</h3> -->
6+
<div class="admonition-icon">
7+
{{partial "svg/sticky-note.svg" }}
8+
</div>
9+
<div class="admonition-content">
10+
{{- .Inner -}}
11+
</div>
12+
</aside>

‎layouts/shortcodes/tip.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{{ $_hugo_config := `{ "version": 1 }` }}
2+
<aside class="admonition tip">
3+
<!-- <h2 id="{{if .Get 0}}{{.Get 0 | urlize}}{{else}}tip{{end}}">{{if .Get 0}}{{.Get 0 | markdownify}}{{else}}Tip{{end}}</h2> -->
4+
<!-- <h3>Tip</h3> -->
5+
<div class="admonition-icon">
6+
{{partial "svg/lightbulb.svg" }}
7+
</div>
8+
<div class="admonition-content">
9+
{{- .Inner -}}
10+
</div>
11+
</aside>

‎layouts/shortcodes/warning.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{{ $_hugo_config := `{ "version": 1 }` }}
2+
<aside class="admonition warning">
3+
<!-- <h2 id="{{if .Get 0}}{{.Get 0 | urlize}}{{else}}warning{{end}}">{{if .Get 0}}{{.Get 0 | markdownify}}{{else}}Warning{{end}}</h2> -->
4+
<!-- <h3>Warning</h3> -->
5+
<div class="admonition-icon">
6+
{{partial "svg/exclamation.svg" }}
7+
</div>
8+
<div class="admonition-content">
9+
{{- .Inner -}}
10+
</div>
11+
</aside>

0 commit comments

Comments
 (0)