docs icon indicating copy to clipboard operation
docs copied to clipboard

mention syntax highlight requirements in track documentation

Open lucaferranti opened this issue 1 year ago • 1 comments

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.

lucaferranti avatar May 10 '24 11:05 lucaferranti

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

ee7 avatar May 10 '24 12:05 ee7

Hi @lucaferranti , I’m a first-time contributor 🙂.
I’d love to update the documentation to clearly mention the codemirror and highlight.js requirements.
Can I work on this?

amritamishra01 avatar Sep 10 '25 06:09 amritamishra01

I don't believe these docs are open to outside contributions.

IsaacG avatar Sep 10 '25 07:09 IsaacG