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

[Accessibility] Pretty-print code samples in the help guides #79

Open
eatyourgreens opened this issue Jan 23, 2024 · 1 comment · May be fixed by #80
Open

[Accessibility] Pretty-print code samples in the help guides #79

eatyourgreens opened this issue Jan 23, 2024 · 1 comment · May be fixed by #80

Comments

@eatyourgreens
Copy link
Contributor

eatyourgreens commented Jan 23, 2024

Help currently uses low quality screenshots of formatted code, like this one from the transcription guide.
A rather blurry screenshot of a JSON snippet from the transcription guide.

I'm 90% sure mkdocs supports code formatting (possibly via a plugin), which would improve the readability and accessibility of these code examples. Something like the following example, in GitHub-flavoured markdown:

{
  "task": "T52",
  "task_label": null,
  "value": [
    {
      "task": "T15",
      "value": [
        {
          "select_label": "Sentenced (month)",
          "option": true,
          "value": 3,
          "label": "3 - March"
        }
      ]
    }
  ]
}
@eatyourgreens eatyourgreens linked a pull request Jan 23, 2024 that will close this issue
@eatyourgreens
Copy link
Contributor Author

MKDocs code blocks answered enough of my questions to be able to open a PR.

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

Successfully merging a pull request may close this issue.

1 participant