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

mention syntax highlight requirements in track documentation #501

Open
lucaferranti opened this issue May 10, 2024 · 1 comment
Open

mention syntax highlight requirements in track documentation #501

lucaferranti opened this issue May 10, 2024 · 1 comment

Comments

@lucaferranti
Copy link
Member

lucaferranti commented May 10, 2024

Currently, exercism needs

  • a codemirror plugin (for the editor)
  • a highlightjs plugin (for the rest)

As far as I can tell, these requirements are not mentioned in the track documentation, it would be very nice to have at least a short mention about these requirements, so that people who start working on a new track can know it from the beginning.

@ee7
Copy link
Member

ee7 commented May 10, 2024

Sounds good to me to improve docs regarding highlightjs and codemirror. Currently there's a little mention regarding highlightjs:

- `highlightjs_language`: the language identifier for Highlight.js (see the [full list of identifiers](https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md)). If there is no Highlight.js support, this field can be omitted.

However, I think Exercism staff usually handle this when launching a track - for codemirror, the required change is in the exercism/website repo, which is mostly for staff.

I think it's also not strictly a requirement to have those plugins - it's just a requirement for syntax highlighting. There wasn't a codemirror plugin for Zig, so the track initially launched without syntax highlighting. And we can always just pick another language as a workaround (Zig is highlighted as Rust).

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

2 participants