From bf0713c0cf27512a7730154f8a6ffa5dc6bc8b15 Mon Sep 17 00:00:00 2001 From: ZhenShuo Leo <98386542+ZhenShuo2021@users.noreply.github.com> Date: Wed, 31 Dec 2025 15:02:45 +0800 Subject: [PATCH] feat(admonition): support arbitrary icon --- exampleSite/content/docs/shortcodes/index.it.md | 10 ++++++---- exampleSite/content/docs/shortcodes/index.ja.md | 10 ++++++---- exampleSite/content/docs/shortcodes/index.md | 14 ++++++++------ exampleSite/content/docs/shortcodes/index.zh-cn.md | 10 ++++++---- layouts/_default/_markup/render-blockquote.html | 10 ++++++++-- 5 files changed, 34 insertions(+), 20 deletions(-) diff --git a/exampleSite/content/docs/shortcodes/index.it.md b/exampleSite/content/docs/shortcodes/index.it.md index 995b5894..9cf47639 100644 --- a/exampleSite/content/docs/shortcodes/index.it.md +++ b/exampleSite/content/docs/shortcodes/index.it.md @@ -71,18 +71,20 @@ Admonitions allow you to insert eye-catching callout boxes in your content. Admonitions serve a similar purpose as the alert shortcode but are implemented via Hugo render hooks. The key difference is syntax: admonitions use Markdown syntax, making them more portable across different platforms, whereas shortcodes are specific to Hugo. The syntax resembles GitHub alerts: ```md -> [!NOTE] -> A Note type admonition. +> [!TIP] +> A Tip type admonition. > [!TIP]+ Custom Title > A collapsible admonition with custom title. +{icon="twitter"} ``` -> [!NOTE] -> A Note type admonition. +> [!TIP] +> A Tip type admonition. > [!TIP]+ Custom Title > A collapsible admonition with custom title. +{icon="twitter"} The alert sign (`+` or `-`) is optional to control whether the admonition is folded or not. Note that alert sign is only compatible in Obsidian. diff --git a/exampleSite/content/docs/shortcodes/index.ja.md b/exampleSite/content/docs/shortcodes/index.ja.md index dbae5cdf..e9db2a08 100644 --- a/exampleSite/content/docs/shortcodes/index.ja.md +++ b/exampleSite/content/docs/shortcodes/index.ja.md @@ -71,18 +71,20 @@ Admonitions は、文書内で読者の注意を引くための強調表示を Admonitions は alert ショートコードと同様の目的を持ちますが、Hugo の render hooks を用いて実装されています。両者の主な違いは構文にあります。admonitions は Markdown 構文を使用するため、異なるプラットフォーム間でも扱いやすく、一方、ショートコードは Hugo 固有の仕組みです。構文は GitHub の alerts に近い形式です。 ```md -> [!NOTE] -> NOTE タイプの表示例。 +> [!TIP] +> Tip タイプの表示例。 > [!TIP]+ カスタムタイトル > タイトルを指定した折りたたみ可能な表示例。 +{icon="twitter"} ``` -> [!NOTE] -> NOTE タイプの表示例。 +> [!TIP] +> Tip タイプの表示例。 > [!TIP]+ カスタムタイトル > タイトルを指定した折りたたみ可能な表示例。 +{icon="twitter"} 記号(`+` または `-`)は任意で、表示を折りたたむかどうかを制御します。なお、この記号は Obsidian のみ対応しています。 diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index 5f40e991..1eb90e6a 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -71,18 +71,20 @@ Admonitions allow you to insert eye-catching callout boxes in your content. Admonitions serve a similar purpose as the alert shortcode but are implemented via Hugo render hooks. The key difference is syntax: admonitions use Markdown syntax, making them more portable across different platforms, whereas shortcodes are specific to Hugo. The syntax resembles GitHub alerts: ```md -> [!NOTE] -> A Note type admonition. +> [!TIP] +> A Tip type admonition. -> [!TIP]+ Custom Title +> [!TIP]+ Custom Title + Custom Icon > A collapsible admonition with custom title. +{icon="twitter"} ``` -> [!NOTE] -> A Note type admonition. +> [!TIP] +> A Tip type admonition. -> [!TIP]+ Custom Title +> [!TIP]+ Custom Title + Custom Icon > A collapsible admonition with custom title. +{icon="twitter"} The alert sign (`+` or `-`) is optional to control whether the admonition is folded or not. Note that alert sign is only compatible in Obsidian. diff --git a/exampleSite/content/docs/shortcodes/index.zh-cn.md b/exampleSite/content/docs/shortcodes/index.zh-cn.md index df543782..fe13f5c0 100644 --- a/exampleSite/content/docs/shortcodes/index.zh-cn.md +++ b/exampleSite/content/docs/shortcodes/index.zh-cn.md @@ -71,18 +71,20 @@ Admonition 用于在内容中插入醒目提示。 Admonition 的用途与 alert shortcode 类似,但其实现方式是通过 Hugo 的 render hooks。两者的关键区别在于语法:admonition 使用 Markdown 语法,因此在不同平台之间具有更好的可移植性;而 shortcode 是 Hugo 专有的。其语法类似 GitHub 的 alerts: ```md -> [!NOTE] -> 一个 NOTE 类型的提示块。 +> [!TIP] +> 一个 Tip 类型的提示块。 > [!TIP]+ 自定义标题 > 一个带有自定义标题的可折叠提示块。 +{icon="twitter"} ``` -> [!NOTE] -> 一个 NOTE 类型的提示块。 +> [!TIP] +> 一个 Tip 类型的提示块。 > [!TIP]+ 自定义标题 > 一个带有自定义标题的可折叠提示块。 +{icon="twitter"} 提示符号(`+` 或 `-`)是可选的,用于控制提示块是否默认折叠。请注意,该提示符号仅在 Obsidian 中兼容。 diff --git a/layouts/_default/_markup/render-blockquote.html b/layouts/_default/_markup/render-blockquote.html index 0b22ee35..69de060e 100644 --- a/layouts/_default/_markup/render-blockquote.html +++ b/layouts/_default/_markup/render-blockquote.html @@ -34,7 +34,8 @@ {{- $rawType := .AlertType | lower -}} {{- $normalizedType := index $typeMap $rawType | default $rawType -}} - {{- $iconName := index $iconMap $normalizedType | default "circle-info" -}} + {{- $iconName := .Attributes.icon | default (index $iconMap $normalizedType) | default "circle-info" -}} + {{- $admonitionTitle := .AlertTitle | default (i18n (printf "admonition.%s" $normalizedType) | default $normalizedType) -}} {{- $containerClass := "admonition relative overflow-hidden rounded-lg border-l-4 my-3 px-4 py-3 shadow-sm" -}} @@ -84,7 +85,12 @@ {{- end -}} {{- else -}} -
+{{- .Text | safeHTML -}}{{- end -}}