You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-5Lines changed: 21 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
This docsify plugin converts blockquotes into beautiful alerts. Look and feel can be configured on a global as well as on an alert specific level so output does fit your needs (some examples are shown below). In addition, you can provide own alert types.
8
8
9
-

9
+

10
10
11
11
## Installation and Usage
12
12
@@ -21,9 +21,8 @@ Assuming you have a working [docsify](https://docsify.js.org) app set up, it is
2. In docsify setup configure the plugin so it does fit your needs. A custom setup is not mandatory. By default, styles `flat` and `callout` (Default: `callout`) and types `NOTE`, `TIP`, `WARNING` and `ATTENTION` are supported.
25
-
26
-
You can change it using plugin configuration via `index.html` or for a single alert in your markdown files. (please see section `Customizations` for further details)
24
+
2. In docsify setup configure the plugin so it does fit your needs. A custom setup is not mandatory. By default, styles `flat` and `callout` (Default: `callout`) and types `NOTE`, `TIP`, `WARNING`, `IMPORTANT` and `ATTENTION` are supported. For a better compatibility some aliases exists. `INFO`, `DANGER` and `CAUTION` can also be used to define the alerts.
25
+
You can change it using plugin configuration via `index.html` or for a single alert in your markdown files. (please see section `Customizations` for further details)
27
26
28
27
**Sample `index.html` file using style `flat` instead of `callout`**
29
28
@@ -52,6 +51,9 @@ Assuming you have a working [docsify](https://docsify.js.org) app set up, it is
52
51
warning: {
53
52
label:"Warnung"
54
53
},
54
+
important: {
55
+
label:"Wichtig"
56
+
},
55
57
attention: {
56
58
label:"Achtung"
57
59
}
@@ -84,6 +86,12 @@ Assuming you have a working [docsify](https://docsify.js.org) app set up, it is
84
86
'/':'Warning'
85
87
}
86
88
},
89
+
important: {
90
+
label: {
91
+
'/de-DE/':'Wichtig',
92
+
'/':'Important'
93
+
}
94
+
},
87
95
attention: {
88
96
label: {
89
97
'/de-DE/':'Achtung',
@@ -120,6 +128,13 @@ Modify or add a new blockquote so it matches required syntax like shown in follo
120
128
> An alert of type 'warning' using global style 'callout'.
121
129
```
122
130
131
+
* Sample alert using type `IMPORTANT`
132
+
133
+
```markdown
134
+
> [!IMPORTANT]
135
+
> An alert of type 'important' using global style 'callout'.
136
+
```
137
+
123
138
* Sample alert using type `ATTENTION`
124
139
125
140
```markdown
@@ -133,7 +148,7 @@ Serve your documentation (`docsify serve`) as usual.
133
148
134
149
## Customizations
135
150
136
-
To use the plugin just modify an existing blockquote and prepend a line matching pattern `[!type]`. By default, types `NOTE`, `TIP`, `WARNING`and `ATTENTION` are supported. You can extend the available types by providing a valid configuration (see below for an example).
151
+
To use the plugin just modify an existing blockquote and prepend a line matching pattern `[!type]`. By default, types `NOTE`, `TIP`, `WARNING`, `IMPORTANT`and `ATTENTION` along with some aliases are supported. You can extend the available types by providing a valid configuration (see below for an example).
137
152
138
153
```markdown
139
154
> [!NOTE]
@@ -225,6 +240,7 @@ If alerts do not look as expected, check if your `index.html` as well as alerts
225
240
## Changelog
226
241
227
242
09/30/2025
243
+
* Added alert type `IMPORTANT` along with some new aliases.
0 commit comments