diff --git a/README.id.md b/README.id.md index 662385ba..ec1c34e3 100644 --- a/README.id.md +++ b/README.id.md @@ -40,7 +40,8 @@ Blowfish dirancang sebagai tema yang kuat dan ringan untuk [Hugo](https://gohugo - Daftar isi yang dapat digulir - Dukungan untuk konten multibahasa termasuk bahasa RTL - Kemampuan untuk menautkan ke artikel di situs web pihak ketiga -- Dukungan untuk beberapa shortcode seperti Galeri, Timeline, Kartu GitHub, dan Carousel +- Dukungan untuk beberapa shortcode seperti Galeri, Timeline, Kartu GitHub, dan Carousel +- Sintaks GitHub Alerts, 15 jenis, dukungan lipat - Integrasi BuyMeACoffee - Pencarian situs berbasis klien dengan Fuse.js - Diagram dan visualisasi menggunakan Mermaid diff --git a/README.ja.md b/README.ja.md index a7a73f73..ccce3140 100644 --- a/README.ja.md +++ b/README.ja.md @@ -45,6 +45,7 @@ Blowfishは[Hugo](https://gohugo.io)のために設計された強力で軽量 - RTL 言語を含む多言語コンテンツのサポート - サードパーティー ウェブサイトの投稿へのリンク - ギャラリー、タイムライン、GitHub カード、カルーセルなど、複数のショートコードに対応 +- GitHub Alerts 構文、15 種類、折りたたみ対応 - Buy Me a Coffee 連携 - Fuse.js を利用したクライアントサイドのサイト内検索 - Mermaid を使用したダイアグラムや視覚化 diff --git a/README.md b/README.md index d8f8af3b..10791da9 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ Blowfish is designed to be a powerful, lightweight theme for [Hugo](https://gohu - Multilingual content support including support for RTL languages - Ability to link to posts on third-party websites - Support for several shortcodes like Gallery, Timeline, GitHub cards, and Carousels +- GitHub Alerts syntax, 15 types, collapsible support - Buymeacoffee integration - Client-side site search powered by Fuse.js - Diagrams and visualisations using Mermaid diff --git a/README.zh-cn.md b/README.zh-cn.md index 30438b77..e4879d97 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -43,6 +43,7 @@ Blowfish 是一个轻量有力的 Hugo 主题。它使用 Tailwind CSS 构建， - 支持多语言内容，包括 RTL 语言 - 可链接到第三方网站上的帖子 - 支持多种简码，如图库、时间轴、GitHub 卡片和图片灯箱 +- 支持 GitHub Alerts 语法、15 种类型和可折叠功能 - 支持 Buymeacoffee - 拥有由 Fuse.js 支持的客户端一侧网站搜索功能 - 植入了基于 Mermaid 的图表功能 diff --git a/exampleSite/content/docs/shortcodes/index.it.md b/exampleSite/content/docs/shortcodes/index.it.md index 3034d038..f6e73908 100644 --- a/exampleSite/content/docs/shortcodes/index.it.md +++ b/exampleSite/content/docs/shortcodes/index.it.md @@ -64,6 +64,36 @@ This is an error!


+## Admonition + +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]+ Custom Title +> A collapsible admonition with custom title. +``` + +> [!NOTE] +> A Note type admonition. + +> [!TIP]+ Custom Title +> A collapsible admonition with custom title. + +The alert sign (`+` or `-`) is optional to control whether the admonition is folded or not. Note that alert sign is only compatible in Obsidian. + +> [!INFO]- Supported types +> Valid admonition types include [GitHub alert types](https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/) and [Obsidian callout types](https://help.obsidian.md/callouts). The types are case-insensitive. +> +> **GitHub types:** `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, `CAUTION` +> **Obsidian types:** `note`, `abstract`, `info`, `todo`, `tip`, `success`, `question`, `warning`, `failure`, `danger`, `bug`, `example`, `quote` + +


+ ## Article `Article` will embed a single article into a markdown file. The `link` to the file should be the `.RelPermalink` of the file to be embedded. Note that the shortcode will not display anything if it's referencing it's parent. *Note: if you are running your website in a subfolder like Blowfish (i.e. /blowfish/) please include that path in the link.* diff --git a/exampleSite/content/docs/shortcodes/index.ja.md b/exampleSite/content/docs/shortcodes/index.ja.md index 221770f9..01d49e4e 100644 --- a/exampleSite/content/docs/shortcodes/index.ja.md +++ b/exampleSite/content/docs/shortcodes/index.ja.md @@ -64,6 +64,36 @@ Twitter で私を[フォロー](https://twitter.com/nunocoracao)するのを忘


+## Admonition + +Admonitions は、文書内で読者の注意を引くための強調表示を挿入するための機能です。 + +Admonitions は alert ショートコードと同様の目的を持ちますが、Hugo の render hooks を用いて実装されています。両者の主な違いは構文にあります。admonitions は Markdown 構文を使用するため、異なるプラットフォーム間でも扱いやすく、一方、ショートコードは Hugo 固有の仕組みです。構文は GitHub の alerts に近い形式です。 + +```md +> [!NOTE] +> NOTE タイプの表示例。 + +> [!TIP]+ カスタムタイトル +> タイトルを指定した折りたたみ可能な表示例。 +``` + +> [!NOTE] +> NOTE タイプの表示例。 + +> [!TIP]+ カスタムタイトル +> タイトルを指定した折りたたみ可能な表示例。 + +記号（`+` または `-`）は任意で、表示を折りたたむかどうかを制御します。なお、この記号は Obsidian のみ対応しています。 + +> [!INFO]- 対応しているタイプ +> 使用可能なタイプには、[GitHub alert タイプ](https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/) および [Obsidian callout タイプ](https://help.obsidian.md/callouts) が含まれます。タイプ名は大文字・小文字を区別しません。 +> +> **GitHub タイプ：** `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, `CAUTION` +> **Obsidian タイプ：** `note`, `abstract`, `info`, `todo`, `tip`, `success`, `question`, `warning`, `failure`, `danger`, `bug`, `example`, `quote` + +


+ ## 記事 `Article` は、1つの記事を Markdown ファイルに埋め込みます。埋め込むファイルへの `link` は、埋め込むファイルの `.RelPermalink` である必要があります。ショートコードは、親を参照している場合は何も表示しないことに注意してください。*注: Blowfish (/blowfish/ など) のようなサブフォルダでウェブサイトを実行している場合は、そのパスをリンクに含めてください。* diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index 0b72c969..5a40fc96 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -64,9 +64,39 @@ This is an error!


+## Admonition + +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]+ Custom Title +> A collapsible admonition with custom title. +``` + +> [!NOTE] +> A Note type admonition. + +> [!TIP]+ Custom Title +> A collapsible admonition with custom title. + +The alert sign (`+` or `-`) is optional to control whether the admonition is folded or not. Note that alert sign is only compatible in Obsidian. + +> [!INFO]- Supported types +> Valid admonition types include [GitHub alert types](https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/) and [Obsidian callout types](https://help.obsidian.md/callouts). The types are case-insensitive. +> +> **GitHub types:** `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, `CAUTION` +> **Obsidian types:** `note`, `abstract`, `info`, `todo`, `tip`, `success`, `question`, `warning`, `failure`, `danger`, `bug`, `example`, `quote` + +


+ ## Article -`Article` will embed a single article into a markdown file. The `link` to the file should be the `.RelPermalink` of the file to be embedded. Note that the shortcode will not display anything if it's referencing it's parent. *Note: if you are running your website in a subfolder like Blowfish (i.e. /blowfish/) please include that path in the link.* +`Article` will embed a single article into a markdown file. The `link` to the file should be the `.RelPermalink` of the file to be embedded. Note that the shortcode will not display anything if it's referencing it's parent. _Note: if you are running your website in a subfolder like Blowfish (i.e. /blowfish/) please include that path in the link._ | Parameter | Description | @@ -202,16 +232,15 @@ This shortcode is for importing code from external sources easily without copyin | `startLine` | **Optional** The line number to start the import from. | | `endLine` | **Optional** The line number to end the import at. | - - **Example:** ```md {{}} ``` + {{< codeimporter url="https://raw.githubusercontent.com/nunocoracao/blowfish/main/layouts/shortcodes/mdimporter.html" type="go" >}} ```md @@ -221,7 +250,6 @@ This shortcode is for importing code from external sources easily without copyin {{< codeimporter url="https://raw.githubusercontent.com/nunocoracao/blowfish/main/config/_default/hugo.toml" type="toml" startLine="11" endLine="18">}} -

## Codeberg Card @@ -239,6 +267,7 @@ This shortcode is for importing code from external sources easily without copyin ```md {{}} ``` + {{< codeberg repo="forgejo/forgejo" >}}


@@ -304,6 +333,7 @@ Blowfish also supports automatic conversion of images included using standard Ma ```md {{}} ``` + {{< forgejo server="https://v11.next.forgejo.org" repo="a/mastodon" >}}


@@ -340,7 +370,6 @@ In order to add images to the gallery, use `img` tags for each image and add `cl


- **Example 2: responsive gallery** ```md @@ -411,6 +440,7 @@ In order to add images to the gallery, use `img` tags for each image and add `cl ```md {{}} ``` + {{< gitea server="https://git.fsfe.org" repo="FSFE/fsfe-website" >}}


@@ -438,7 +468,7 @@ In order to add images to the gallery, use `img` tags for each image and add `cl ## GitLab Card -`gitlab` allows you to quickly link a GitLab Project (GitLab's jargon for repo). +`gitlab` allows you to quickly link a GitLab Project (GitLab's jargon for repo). It displays realtime stats about it, such as the number of stars and forks it has. Unlike `github` it can't display the main programming language of a project. Finally, custom GitLab instance URL can be provided, as long as the `api/v4/projects/` endpoint is available, making this shortcode compatible with most self-hosted / enterprise deployments. @@ -531,13 +561,10 @@ Check out the [mathematical notation samples]({{< ref "mathematical-notation" >}


- ## Keyword - The `keyword` component can be used to visually highlight certain important words or phrases, e.g. professional skills etc. The `keywordList` shortcode can be used to group together multiple `keyword` items. Each item can have the following properties. - | Parameter | Description | | --------- | --------------------------------------- | @@ -552,7 +579,7 @@ The input is written in Markdown so you can format it however you please. {{}} *Super* skill {{}} ``` -{{< keyword >}} *Super* skill {{< /keyword >}} +{{< keyword >}} _Super_ skill {{< /keyword >}} **Example2 :** @@ -569,7 +596,7 @@ The input is written in Markdown so you can format it however you please. {{< keyword icon="github" >}} Lorem ipsum dolor {{< /keyword >}} {{< keyword icon="code" >}} **Important** skill {{< /keyword >}} {{< /keywordList >}} -{{< keyword >}} *Standalone* skill {{< /keyword >}} +{{< keyword >}} _Standalone_ skill {{< /keyword >}}


@@ -589,7 +616,7 @@ When life gives you lemons, make lemonade. When life gives you lemons, make lemonade. {{< /lead >}} -


+


## List @@ -628,7 +655,7 @@ The `where` and `value` values are used in the following query `where .Site.Regu


-## LTR/RTL +## LTR/RTL `ltr` and `rtl` allows you to mix your contents. Many RTL language users want to include parts of the content in LTR. Using this shortcode will let you do so, and by leveraging `%` as the outer-most dilemeter in the shortcode [Hugo shortcodes](https://gohugo.io/content-management/shortcodes/#shortcodes-with-markdown), any markdown inside will be rendered normally. @@ -661,10 +688,8 @@ This shortcode allows you to import markdown files from external sources. This i | --------- | ------------------------------------------------------- | | `url` | **Required** URL to an externally hosted markdown file. | - - **Example:** ```md @@ -674,7 +699,6 @@ This shortcode allows you to import markdown files from external sources. This i {{< mdimporter url="https://raw.githubusercontent.com/nunocoracao/nunocoracao/master/README.md" >}} -

## Mermaid @@ -724,7 +748,6 @@ You can see some additional Mermaid examples on the [diagrams and flowcharts sam The `timeline` creates a visual timeline that can be used in different use-cases, e.g. professional experience, a project's achievements, etc. The `timeline` shortcode relies on the `timelineItem` sub-shortcode to define each item within the main timeline. Each item can have the following properties. - | Parameter | Description | | ----------- | -------------------------------------------- | @@ -775,14 +798,12 @@ With other shortcodes {{}} ``` - {{< timeline >}} {{< timelineItem icon="github" header="header" badge="badge test" subheader="subheader" >}} Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus non magna ex. Donec sollicitudin ut lorem quis lobortis. Nam ac ipsum libero. Sed a ex eget ipsum tincidunt venenatis quis sed nisl. Pellentesque sed urna vel odio consequat tincidunt id ut purus. Nam sollicitudin est sed dui interdum rhoncus. {{}} - {{< timelineItem icon="code" header="Another Awesome Header" badge="date - present" subheader="Awesome Subheader">}} With html code