|
2 | 2 |
|
3 | 3 | author: André Dietrich |
4 | 4 | email: LiaScript@web.de |
5 | | -date: 25/3/2025 |
6 | | -version: 33.0.1 |
| 5 | +date: 29/04/2026 |
| 6 | +version: 34.0.0 |
7 | 7 | language: en |
8 | 8 | narrator: UK English Female |
9 | 9 |
|
@@ -1316,6 +1316,129 @@ combined, it could also be a gallery or an embedded object... |
1316 | 1316 |
|
1317 | 1317 | ******************************************************************************** |
1318 | 1318 |
|
| 1319 | +#### Alerts |
| 1320 | +
|
| 1321 | + --{{0}}-- |
| 1322 | +Many Markdown readers — including GitHub and LiaScript — support a special alert |
| 1323 | +syntax built on top of blockquotes. An alert is simply a blockquote whose first |
| 1324 | +line contains a keyword in square brackets, prefixed with an exclamation mark. |
| 1325 | +Five types are defined by the GitHub flavored Markdown specification, each |
| 1326 | +carrying a different semantic meaning and visual style. |
| 1327 | +
|
| 1328 | +**Syntax:** |
| 1329 | +
|
| 1330 | +<!-- class="translate"--> |
| 1331 | +``` markdown |
| 1332 | +> [!NOTE] |
| 1333 | +> Highlights information that users should take into account, even when skimming. |
| 1334 | +
|
| 1335 | +> [!TIP] |
| 1336 | +> Optional information to help a user be more successful. |
| 1337 | +
|
| 1338 | +> [!IMPORTANT] |
| 1339 | +> Crucial information necessary for users to succeed. |
| 1340 | +
|
| 1341 | +> [!WARNING] |
| 1342 | +> Critical content demanding immediate user attention due to potential risks. |
| 1343 | +
|
| 1344 | +> Nesting is of course also possible: |
| 1345 | +> |
| 1346 | +>> [!CAUTION] |
| 1347 | +>> Negative potential consequences of an action. |
| 1348 | +>> |
| 1349 | +>> - due to |
| 1350 | +>> - some reasons |
| 1351 | +``` |
| 1352 | +
|
| 1353 | + {{1}} |
| 1354 | +<section> |
| 1355 | +
|
| 1356 | + --{{1}}-- |
| 1357 | +The GitHub-flavoured icons were used as an inspiration for this type of alerts. |
| 1358 | +
|
| 1359 | +**Result:** |
| 1360 | +
|
| 1361 | +
|
| 1362 | +> [!NOTE] |
| 1363 | +> Highlights information that users should take into account, even when skimming. |
| 1364 | +
|
| 1365 | +> [!TIP] |
| 1366 | +> Optional information to help a user be more successful. |
| 1367 | +
|
| 1368 | +> [!IMPORTANT] |
| 1369 | +> Crucial information necessary for users to succeed. |
| 1370 | +
|
| 1371 | +> [!WARNING] |
| 1372 | +> Critical content demanding immediate user attention due to potential risks. |
| 1373 | +
|
| 1374 | +> Nesting is of course also possible: |
| 1375 | +> |
| 1376 | +>> [!CAUTION] |
| 1377 | +>> Negative potential consequences of an action. |
| 1378 | +>> |
| 1379 | +>> - due to |
| 1380 | +>> - some reasons |
| 1381 | +
|
| 1382 | +</section> |
| 1383 | +
|
| 1384 | + {{2}} |
| 1385 | +<section> |
| 1386 | +
|
| 1387 | +**GitLab-style with custom titles and icons:** |
| 1388 | +
|
| 1389 | + --{{2}}-- |
| 1390 | +GitLab extends this syntax by allowing a custom title directly after the keyword, |
| 1391 | +separated by a space. LiaScript supports this style too, so you can use it |
| 1392 | +regardless of where your document is hosted. When you provide a custom title, |
| 1393 | +you can also embed an emoji or icon of your choice — the default icon associated |
| 1394 | +with the alert type will then be replaced by whatever you put in the title. |
| 1395 | +
|
| 1396 | +<!-- class="translate"--> |
| 1397 | +``` markdown |
| 1398 | +> [!NOTE] 📝 Keep this in mind |
| 1399 | +> Both GitHub and GitLab will render this, though the visual style differs |
| 1400 | +> between platforms. |
| 1401 | +
|
| 1402 | +> [!TIP] 💡 Pro tip |
| 1403 | +> Use custom titles to give your alerts more context at a glance. |
| 1404 | +
|
| 1405 | +> [!IMPORTANT] ❗ Don't skip this |
| 1406 | +> Custom titles replace the default icon with whatever emoji you choose. |
| 1407 | +
|
| 1408 | +> [!WARNING] ⚠️ Proceed with caution |
| 1409 | +> This action cannot be undone once confirmed. |
| 1410 | +
|
| 1411 | +> [!CAUTION] 🔥 Danger zone |
| 1412 | +> Misusing this feature may lead to data loss. |
| 1413 | +``` |
| 1414 | +
|
| 1415 | +</section> |
| 1416 | +
|
| 1417 | +
|
| 1418 | + {{3}} |
| 1419 | +<section> |
| 1420 | +
|
| 1421 | + --{{3}}-- |
| 1422 | +The results are now more personalized, and the alert titles can be translated this way to support other languages too. |
| 1423 | +
|
| 1424 | +> [!NOTE] 📝 Keep this in mind |
| 1425 | +> Both GitHub and GitLab will render this, though the visual style differs |
| 1426 | +> between platforms. |
| 1427 | +
|
| 1428 | +> [!TIP] 💡 Pro tip |
| 1429 | +> Use custom titles to give your alerts more context at a glance. |
| 1430 | +
|
| 1431 | +> [!IMPORTANT] ❗ Don't skip this |
| 1432 | +> Custom titles replace the default icon with whatever emoji you choose. |
| 1433 | +
|
| 1434 | +> [!WARNING] ⚠️ Proceed with caution |
| 1435 | +> This action cannot be undone once confirmed. |
| 1436 | +
|
| 1437 | +> [!CAUTION] 🔥 Danger zone |
| 1438 | +> Misusing this feature may lead to data loss. |
| 1439 | +
|
| 1440 | +</section> |
| 1441 | +
|
1319 | 1442 | #### Citations 💫 |
1320 | 1443 |
|
1321 | 1444 | --{{0}}-- |
|
0 commit comments