Skip to content
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.

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

Does not support native GitHub Pages MermaidJs support. #39

Closed
duaneking opened this issue Jun 11, 2022 · 2 comments
Closed

Does not support native GitHub Pages MermaidJs support. #39

duaneking opened this issue Jun 11, 2022 · 2 comments
Labels
enhancement New feature or request wontfix This will not be worked on

Comments

@duaneking
Copy link

duaneking commented Jun 11, 2022

I want to be able to copy and paste a index.md file from a GitHub repo where it renders with MermaidJS just fine, and have it render effectively the same diagram after being rendered on GH Pages.

The current build system actively corrupts Mermaid rendered files and makes them impossible to render as expected.

The fact that safe=true is hard coded means we cant add a plugin that would support this to the default pipeline without githubs help.

I'm trying to support efforts for the blind to be able to more easily communicate visual ideas to the sighted and this support is critical to allow that using MermaidJS. I am formally asking for all reasonable accommodation from GitHub and developers to support this goal.

@JamesMGreene JamesMGreene added the enhancement New feature or request label Aug 18, 2022
@JamesMGreene
Copy link
Contributor

JamesMGreene commented Aug 18, 2022

@duaneking It seems unlikely [to me] that this will get added into the implicit GitHub Pages builds as that configuration has rarely changed in any meaningful way.

However, we have recently done a beta release adding the ability to customize your Pages deployments completely if you're willing to use GitHub Actions as your build-and-deployment mechanism with a custom workflow rather than relying on the implicit GitHub Pages functionality.

Here's an example starter workflow for building with Ruby 3.x and whichever version of Jekyll you have configured (vs. being stuck on Jekyll 3.x with the implicit GitHub Pages builds):
https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml

This would allow you to customize your site with any Jekyll plugins you'd like since the build configuration is left entirely up to you. 👍🏻

@JamesMGreene JamesMGreene added the wontfix This will not be worked on label Aug 18, 2022
@JamesMGreene JamesMGreene closed this as not planned Won't fix, can't repro, duplicate, stale Aug 18, 2022
@duaneking
Copy link
Author

duaneking commented Aug 19, 2022

No. You dont get it.

Your just asking the blind to do more work.

GitHub pages was perfect for this before as it did all the work for them, except the critical single step that needs fixed,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants