Whitelist something that lets Jekyll render ```mermaidJS by default so the same markdown renders the same mermaidJS image
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- バグ
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- github, jekyll, ruby
- 領域
- build-system, web-dev
調査の方向性
まず rabestro.github.io/test-mermaid と rabestro/test-mermaid で動作を再現し、次に pages-gem の Jekyll レンダリングパイプラインとそのプラグインホワイトリストを調査します。GitHub Markdown の Mermaid 処理と GitHub Pages の出力を比較します。標準的な fenced Mermaid 例が、ユーザーによる追加設定なしで、デフォルトの GitHub Pages フローを通じて正しくレンダリングされれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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
- Everybody on github using GitHub Pages who read https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/
- The blind/disabled development community who wants to use the "standard" mermaid support on GitHub on GitHub Pages to communicate visual ideas.
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
- 主要言語
- Ruby
- スター
- 1.9k
- フォーク
- 361
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/pages-gem のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 5/100
-
index.htmlオープン
難易度 5/5 1週間以上 初心者へのやさしさ 5/100
github/pages-gem の issue をすべて見る
似ている issue
-
area/web interface
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
chef/mixlib-shellout#287 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信