Skip to content

Add support for GFM admonitions in the blog #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2025
Merged

Add support for GFM admonitions in the blog #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a56a95
Add support for GFM admonitions in the blog
hmellor Apr 16, 2025
0795028
Update `jekyll-gfm-admonitions`
hmellor Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
source "https://rubygems.org"

gem "github-pages", "~> 232", group: :jekyll_plugins
group :jekyll_plugins do
gem "github-pages", "~> 232"
gem "jekyll-gfm-admonitions", '~> 1.2'
end
8 changes: 8 additions & 0 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ GEM
commonmarker (0.23.11)
concurrent-ruby (1.3.5)
connection_pool (2.5.0)
cssminify (1.0.2)
csv (3.3.2)
dnsruby (1.72.3)
base64 (~> 0.2.0)
Expand Down Expand Up @@ -138,6 +139,10 @@ GEM
jekyll (>= 3.0, < 5.0)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
jekyll-gfm-admonitions (1.2.0)
cssminify (~> 1.0)
jekyll (>= 3.0, < 5.0)
octicons (~> 19.8)
jekyll-gist (1.5.0)
octokit (~> 4.2)
jekyll-github-metadata (2.16.1)
Expand Down Expand Up @@ -239,6 +244,7 @@ GEM
racc (~> 1.4)
nokogiri (1.18.4-x86_64-linux-gnu)
racc (~> 1.4)
octicons (19.15.1)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
Expand Down Expand Up @@ -275,10 +281,12 @@ GEM

PLATFORMS
arm64-darwin
arm64-darwin-24
x86_64-linux

DEPENDENCIES
github-pages (~> 232)
jekyll-gfm-admonitions (~> 1.2)

BUNDLED WITH
2.6.2
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,30 @@ math block
$$
```

## GitHub Flavored Admonitions

The blog supports GitHub flavored admonitions via [jekyll-gfm-admonition](https://github.com/Helveg/jekyll-gfm-admonitions). It supports the following syntax:

```markdown
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> And supports multi-line text.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate
> user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.
> Opportunity to provide more context.
```

## Theme customization

The theme we are using is [Minima](https://github.com/jekyll/minima). If you need to customise anything from this theme, see [Overriding theme defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults).
1 change: 1 addition & 0 deletions _config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ remote_theme: jekyll/minima@5ce4006d175e6e5278bb63a0aad1a85e3bf2370b
plugins:
- jekyll-feed
- jekyll-seo-tag
- jekyll-gfm-admonitions

# Theme-specific settings

Expand Down