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.

Sign up for GitHub

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

Jump to bottom

Convert Gists to PrismJS #34

Open

aitchiss opened this issue Jan 31, 2020 · 0 comments

Labels

enhancement good first issue hacktoberfest 🎃 help wanted

Owner

aitchiss commented Jan 31, 2020 •

edited

Loading

Code snippets were originally created in Gists, partly because they behaved nicely with screen readers. The downsides however are:

lack of control over styling and syntax highlighting, many of which are throwing warnings in a11y audit tools (the contrast is fine but extensions are unable to determine the background colour)
unnecessary noise on the page with links to GitHub and that annoying heart emoji. Could be fixed by overriding their CSS but the better solution would be to move away entirely

PrismJS does everything we need in an accessible way.

Jobs to be done:

Create an accessible style for Prism code snippets that fits in with the overall UYA palette
Page by page port gists to prism code snippets (each article/page ported to prism code snippets should be a single pull request)

aitchiss added the enhancement label

aitchiss changed the title ~~Investigate alternatives to Gist~~ Convert Gists to PrismJS

aitchiss added good first issue help wanted labels

aitchiss added the hacktoberfest 🎃 label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment