diff --git a/docs/reference/admonitions.md b/docs/reference/admonitions.md index c4defa031..9039770ca 100644 --- a/docs/reference/admonitions.md +++ b/docs/reference/admonitions.md @@ -166,7 +166,7 @@ can use your existing admonitions and indent the desired ones: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. - + !!! note "Inner Note" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod @@ -181,7 +181,7 @@ can use your existing admonitions and indent the desired ones: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. - + !!! note "Inner Note" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod @@ -420,12 +420,13 @@ the default type, and thus fallback for unknown type qualifiers, is `note`[^1]: euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + ## Customization ### Classic admonitions +In previous versions, admonitions had a slightly different appearance. -Prior to version , admonitions had a slightly -different appearance: +#### Prior to version !!! classic "Note" @@ -438,6 +439,8 @@ If you want to restore this appearance, add the following CSS to an + +=== ":octicons-file-code-16: `docs/stylesheets/extra.css`" + + ``` css + .md-typeset .admonition, + .md-typeset details { + --md-admonition-title-bg-color: color-mix(in srgb, var(--md-admonition-color), transparent 90%); + --md-admonition-border-color: var(--md-admonition-color); + } + ``` +=== ":octicons-file-code-16: `mkdocs.yml`" + + ``` yaml + extra_css: + - stylesheets/extra.css + ``` + ### Custom admonitions If you want to add a custom admonition type, all you need is a color and an @@ -467,44 +505,18 @@ If you want to add a custom admonition type, all you need is a color and an and add the following CSS to an [additional style sheet]: === ":octicons-file-code-16: `docs/stylesheets/extra.css`" ``` css - :root { - --md-admonition-icon--pied-piper: url('data:image/svg+xml;charset=utf-8,') - } - .md-typeset .admonition.pied-piper, - .md-typeset details.pied-piper { - border-color: rgb(43, 155, 70); - } - .md-typeset .pied-piper > .admonition-title, - .md-typeset .pied-piper > summary { - background-color: rgba(43, 155, 70, 0.1); - } - .md-typeset .pied-piper > .admonition-title::before, - .md-typeset .pied-piper > summary::before { - background-color: rgb(43, 155, 70); - -webkit-mask-image: var(--md-admonition-icon--pied-piper); - mask-image: var(--md-admonition-icon--pied-piper); + .md-typeset .admonition.pied-piper { + --md-admonition-icon: url('data:image/svg+xml;charset=utf-8,'); + --md-admonition-color: #2b9b46; } ``` diff --git a/src/templates/assets/stylesheets/main/extensions/markdown/_admonition.scss b/src/templates/assets/stylesheets/main/extensions/markdown/_admonition.scss index 90be61245..143fcd811 100644 --- a/src/templates/assets/stylesheets/main/extensions/markdown/_admonition.scss +++ b/src/templates/assets/stylesheets/main/extensions/markdown/_admonition.scss @@ -43,18 +43,29 @@ $admonitions: ( "quote": format-quote-close $clr-grey ) !default; + // ---------------------------------------------------------------------------- -// Rules: layout +// Rules: flavours // ---------------------------------------------------------------------------- // Admonition variables :root { @each $name, $props in $admonitions { - --md-admonition-icon--#{$name}: - svg-load("material/#{list.nth($props, 1)}.svg"); + --md-admonition-color--#{$name}: #{list.nth($props, 2)}; + --md-admonition-icon--#{$name}: svg-load("material/#{list.nth($props, 1)}.svg"); + } +} + +// Admonition flavour - sets color and icon variables for each type +@each $name, $props in $admonitions { + .md-typeset .admonition.#{$name} { + --md-admonition-color: var(--md-admonition-color--#{$name}); + --md-admonition-icon: var(--md-admonition-icon--#{$name}); } } +// ---------------------------------------------------------------------------- +// Rules: layout // ---------------------------------------------------------------------------- // Scoped in typesetted content to match specificity of regular content @@ -63,13 +74,18 @@ $admonitions: ( // Admonition - note that all styles also apply to details tags, which are // rendered as collapsible admonitions with summary elements as titles. .admonition { + --md-admonition-color: var(--md-admonition-color--note); + --md-admonition-title-bg-color: color-mix(in srgb, var(--md-admonition-color), transparent 70%); + --md-admonition-icon: var(--md-admonition-icon--note); + --md-admonition-border-color: var(--md-admonition-title-bg-color); + display: flow-root; padding: 0 px2rem(12px); margin: px2em(20px, 12.8px) 0; font-size: px2rem(12.8px); color: var(--md-admonition-fg-color); background-color: var(--md-admonition-bg-color); - border: px2rem(1px) solid $clr-blue-a200; + border: px2rem(1px) solid var(--md-admonition-border-color); border-radius: px2rem(8px); overflow: hidden; // box-shadow: var(--md-shadow-z1); @@ -127,7 +143,7 @@ $admonitions: ( margin-block: 0; margin-inline: px2rem(-12px); font-weight: 700; - background-color: color.adjust($clr-blue-a200, $alpha: -0.9); + background-color: var(--md-admonition-title-bg-color); border: none; border-inline-start-width: px2rem(4px); @@ -144,8 +160,8 @@ $admonitions: ( width: px2rem(20px); height: px2rem(20px); content: ""; - background-color: $clr-blue-a200; - mask-image: var(--md-admonition-icon--note); + background-color: var(--md-admonition-color); + mask-image: var(--md-admonition-icon); mask-repeat: no-repeat; mask-position: center; mask-size: contain; @@ -157,38 +173,3 @@ $admonitions: ( } } } - -// ---------------------------------------------------------------------------- -// Rules: flavours -// ---------------------------------------------------------------------------- - -// Define admonition flavors -@each $name, $props in $admonitions { - $tint: list.nth($props, 2); - - // Admonition flavour - .md-typeset .admonition.#{$name} { - border-color: color.adjust($tint, $alpha: -0.7); - - // // Admonition on focus - // &:focus-within { - // box-shadow: 0 0 0 px2rem(4px) color.adjust($tint, $alpha: -0.9); - // } - } - - // Admonition flavour title - .md-typeset .#{$name} > .admonition-title { - background-color: color.adjust($tint, $alpha: -0.7); - - // Admonition icon - &::before { - background-color: $tint; - mask-image: var(--md-admonition-icon--#{$name}); - } - - // Details marker - &::after { - color: $tint; - } - } -}