diff --git a/README.md b/README.md index 3eb1827..8704b9a 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,15 @@ localized; links resolve back to GitLab. > to the document's `h2`–`h5` headings (which receive slug `id`s). This also works > for markdown embedded via `` and for release notes. + + +> **Alerts:** GitLab alert blockquotes are rendered as themed callouts. A blockquote +> whose first line is `> [!note]`, `> [!tip]`, `> [!important]`, `> [!caution]`, or +> `> [!warning]` becomes a `
` carrying both `gitlab-md-alert*` hook classes and +> the Docusaurus/Infima `alert alert--` classes (so it inherits theme colors). +> Type matching is case-insensitive; add text after the marker for a custom title, e.g. +> `> [!warning] Data deletion`. This also works for `` markdown and release notes. + ### `` A list of releases with notes, dates, and asset links. @@ -233,6 +242,8 @@ into your `src/css/custom.css` and edit freely. The class names you can target: | `gitlab-release-notes` / `gitlab-release-assets` | release body + asset links | | `gitlab-readme` | rendered README / markdown file | | `gitlab-md-toc` | generated `[[_TOC_]]` table of contents (`