Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Whitelist something that lets Jekyll render ```mermaidJS by default so the same markdown renders the same mermaidJS image

Ouverte
  • Quelque chose ne va pas ?
#835 7 commentaires 8 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Bug
Clarté
À clarifier
Activité
À l'abandon
Stack technique
github, jekyll, ruby
Domaine
build-system, web-dev

Piste de recherche

Commencez par reproduire le comportement dans rabestro.github.io/test-mermaid et rabestro/test-mermaid, puis examinez le pipeline de rendu Jekyll de pages-gem et sa liste blanche de plugins. Comparez la gestion de Mermaid par GitHub Markdown avec le rendu de GitHub Pages. Le travail est considéré comme terminé lorsque l’exemple Mermaid standard avec du fenced code est correctement rendu via le flux GitHub Pages par défaut, sans configuration supplémentaire de la part de l’utilisateur.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

I'm in good faith tracking this as a CRITICAL ACCESSABILITY ISSUE for people in the development community who are visually disabled and use mermaidjs to communicate visual ideas and want to use Github Pages.

Worse, GH stated they supported this in a big blog post, and they clearly don't, because I cant copy a mermaidJS markdown file and have it show up on GitHub Pages using only the default GHPages flow. If this is the wrong place, let me know and I will simply refile this bug as needed to assist in good faith.

This fix needs to be on the GitHub side to mitigate duplicated effort and to support the best accessibility

This issue affects
Issues
  • The site generated by GitHub Pages does not render mermaidJS by default, despite the fact that GH has publicly and falsely declared that its supported across the entire website for all markdown files per https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/ when that is clearly not the case.
  • The jekyll rendering pipeline used by GH pages actively blocks all non-whitelisted plugins from being loaded.
  • The jekyll rendering pipeline used by GH pages does not include a plugin in the whitelist that can be used to render mermaidJS.
  • The jekyll rendering pipeline used by GH Pages also corrupts/mis-renders standard GitHub "```mermaidjs" markdown into "mermaid-language" code html blocks
  • If Github Pages is about ease of use, and if the expectation is that the markdown rendering of GitHub should work on GitHub Pages, that's not happening.
What did you do (e.g., steps to reproduce)

Tried to use standard github markdown with the ```mermaid tag as described on https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/

What did you expect to happen?

I expected it to render mermaid with no other work from me.

What happened instead?

MermaidJS is not rendered at all and the Jykll system is also parsing it wrong and rendering the wrong thing.

Additional information

https://rabestro.github.io/test-mermaid/ and https://github.com/rabestro/test-mermaid shows the issue perfectly

Additional Repos showing this problem:

I also am seeing this on my own github.io

Langage dominant
Ruby
Étoiles
1.9k
Forks
362
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/pages-gem

Toutes les issues de github/pages-gem

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.