search

X2CommunityCore / X2WOTCCommunityHighlander

https://steamcommunity.com/workshop/filedetails/?id=1134256495
MIT License
60 stars 68 forks source link

Documentation: Syntax Highlighting #739

Open robojumper opened 4 years ago

robojumper commented 4 years ago

MkDocs uses highlight.js for syntax highlighting. We have three options for UnrealScript:

  1. Use a different language that is very similar to UC
  2. Add support for UC to upstream highlight.js, then wait for the change to proliferate down to the MkDocs pip repo
  3. Write our own syntax for highlight.js, then add it to our pages with MkDocs theme modification
robojumper commented 4 years ago

As @Xymanek correctly pointed out, some of the docs use a custom event documentation format. Only 3. is feasible for that.

MrNiceUK commented 4 years ago

Although could (3) be combined with (1), ie borrow the bulk of a similar languages highlighting then tweak for the event doc (and any important missing UC highlighting)?