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

XML snippets in rfcxml-vocabulary could be made more accessible #39

Open
ajeanmahoney opened this issue Sep 13, 2022 · 5 comments
Open

Comments

@ajeanmahoney
Copy link
Contributor

The current palette choice for XML snippets may make reading the snippets difficult for someone with colorblindness. For example, the red and green text on a black background found on https://authors.ietf.org/rfcxml-vocabulary#artwork would be difficult for someone with red/green colorblindness to read because colors would appear both dim and the same. (The XML snippets are somewhat eye-straining for me also, and I'm not colorblind).

@JayDaley
Copy link
Contributor

Wiki.js uses https://highlightjs.org as its syntax highlighting library. We'll try to figure out how to use high/higher contrast highlighting with that library

@JayDaley
Copy link
Contributor

This is their list of themes https://github.com/highlightjs/highlight.js/tree/main/src/styles but as noted in this issue highlightjs/highlight.js#3392 they are not labelled by the contrast ratio or WCAG compliance.

On the front page of their site https://highlightjs.org you can click on 'style' underneath the code snippet and it chooses another. From that it looks like maybe 'agate' is best for xml - https://highlightjs.org/?snippet=1&style=10

@ajeanmahoney and/or @rjsparks Can you please confirm that agate is suitable and I will then get that set as the theme.

@rjsparks
Copy link
Contributor

agate works for me. (Either of the solarized would also work if we find that agate is problematic later).

@ajeanmahoney
Copy link
Contributor Author

agate also works for me. I like the contrast. The blues and greens may appear as similar colors to a person with blue-yellow colorblindness, but I think we can go forward with the palette. As Robert says, we can make updates if we receive new feedback.

@JayDaley
Copy link
Contributor

It appears that configuring the underlying highlight.js library is not straightforward. This may require waiting until the next next major version of Wiki.js is released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants