Custom Note/Warning admonitions are not displayed correctly on GFM based GitHub Pages

[rickstaa]

Select Topic Area

Bug

Body

I am currently using the Note and Warning admonitions in the readme of one of my projects. In this project, I want to use the default GitHub pages Jekyll setup to create a simple webpage based on this. All elements except the custom Note/Warning admonitions seem to work. Since these warnings are relatively new, they are, I think, still not supported in the GFM GitHub page conversion. However, I could not find any documentation supporting this hypothesis 🤔.

How to reproduce

1. Create a readme file that contains the Note/Warning admonitions.
2. Set up GitHub pages according to GitHub pages documentation.
3. Use markdown: GFM in your Jekyll _config.yml file.
4. Build the documentation.
5. See that the admonitions are not displayed correctly.

[ettaboyle]

Welcome to the GitHub Community, @rickstaa, we're happy you're here! You are more likely to get a useful response if you are posting your question(s) in the applicable category and are explicit about what your project entails--giving a few more details might help someone give you a nudge in the right direction. I've gone ahead and moved it from general to pages for you. Good luck!

[rickstaa]

@ettaboyle. Great thanks! I wasn't aware the was a pages category 👍🏻.

[MarioPoneder]

@rickstaa
I am having the same problem. Were you already able to find a solution for it?

[rickstaa]

Hello @MarioPoneder, regrettably, the pursuit of a solution continues, and my webpage warnings persist in their slumber (see https://adsb.cool/). It appears that resolution rests in the hands of GitHub, as the required functionality has not yet found its place in the GFM parser.

[MarioPoneder]

Thank you for your response.
It unfortunately seems that GitHub Pages doesn't support GFM as of now, despite the "markdown: GFM" setting.

[rickstaa]

Thank you for your response. It unfortunately seems that GitHub Pages doesn't support GFM as of now, despite the "markdown: GFM" setting.

GFM should be supported by github pages (see https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll). I think maybe the admonition creation logic has not bee implemented in GFM 🤔.

[MarioPoneder]

It should be supported, but I also found that checkmark lists "- [x] ..." and correctly switching between dark/light-mode images isn't supported either.

[daerlnaxe]

Hi, same problem here, about admonitions.

for checkmark it seems to be ok for me.

[Helveg]

Hi! I've went ahead and created a Jekyll plugin that renders GitHub flavored admonitions! Try it out here: https://github.com/Helveg/jekyll-gfm-admonitions

Building GitHub Pages with custom plugins can be quite involved, but I included detailed step-by-step instructions. It would be incredibly useful if you could let me know of any hiccups you encounter along the way.