Syntax Highlighting on Website for Soar Code

[moschmdt]

It would be nice, if the Soar code snippets on the website would have syntax highlighting.

According to the MkDocs Material docs relies on pygments to highlight the syntax of code blocks. Unfortunately, pygments does not have a Soar lexer, yet.

I have created a pygments lexer for Soar in my fork, but this needs more work until it might be in a state which is acceptable to be merged in pygments.

Tasks for native highlighting for Soar code via mkdocs:

• Complete Lexer in fork
• Merge Soar lexer in upstream pygments
• Update mkdocs material version once pygments version is updated.

[garfieldnate]

Wow, a Soar lexer would be really amazing! Writing a general Soar parser is really difficult, but it looks like you don't actually have to do that to get syntax highlighting. This will make our website look a lot better, but will also do the same for anyone else that wants to write/blog about Soar, which would be really wonderful. Thank you! I'm looking forward to this.

[garfieldnate]

Gonna note here since I was thinking about it:

It would be great to have syntax highlighting on GitHub, too, but GitHub asks that there be at least 200 unique repositories that contain a particular language before accepting a new extension to linguist, and I don't think we qualify yet: https://github.com/search?q=path%3A%2F%28%5E%7C%5C%2F%29.*%5C.soar%24%2F&type=code.

[moschmdt]

As of now, the lexer works fairly good, see examples, but everything is very gray due to the coloring of mkdocs material and the pygments tokens for ^variable and <variable> are Name.Variable, cf. test files

Any idea/ suggestion on how to separate ^variable and <variable> into different reasonable pygments tokens without creating a new code highlighting theme for mkdocs (if that is even possible for a single language..)?

Examples

Left-side displays updated version with local pygments version with Soar support, left-side is current upstream version.

Light mode example:

Dark mode example:

[garfieldnate]

Not sure what <> is getting marked as, but I guess it could be an operator or a keyword. The ^xyz tokens could be marked as Name.Property or Name.Attribute perhaps? Not sure how all of the different coloring might look. The gray is indeed unfortunate.

[moschmdt]

<> is currently marked as operator.

I decided to declare all identifiers as Name only. Thus, they have a little darker colorization.