exercism / docs

Exercism's docs. View them at Exercism's website, not on GitHub.
https://exercism.org/docs
43 stars 92 forks source link

mention syntax highlight requirements in track documentation #501

Open lucaferranti opened 4 months ago

lucaferranti commented 4 months ago

Currently, exercism needs

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 commented 4 months ago

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

https://github.com/exercism/docs/blob/10e57200961c71ff0256a6b202da098b3c9d0a61/building/tracks/new/prepare-for-launch.md#L54

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).