Improving C,C++, C# Code Detection

[ValerioOniride]

Context

After several attempts with the extra.css file and experimenting with different language combinations, including C#, I've concluded it's necessary to submit this request

Description

I would like to request an enhancement for the code block parsing capability, specifically to improve its recognition of key elements within C#, C++, and C code blocks. I suggest augmenting the parser to identify and classify these elements with a similar accuracy and granularity as demonstrated in the example provided in the Vsuals section."

Related links

• Requesting a change

Use Cases

Enhancing the API's code block parsing will improve code clarity for both authors and users, ensuring better communication of intended messages. This change will expedite learning and development within the community, aligning with the project's goal of providing accessible documentation and fostering collaboration.

Visuals

Before submitting

• I have read and followed the change request guidelines.
• I have verified that my idea is a change request and not a bug report.
• I have ensured that, to the best of my knowledge, my idea will benefit the entire community.
• I have included relevant links to the documentation, related issues, and discussions to underline the need for my idea.

[alexvoss]

Hi,

the code highlighting is configurable. Which options have you tried and what did you not manage to achieve?

Please note that there is probably nothing to be done in Material for MkDocs per se. Either Pygments or Highlight.js would need to accept a change request. If you decide to contact them, please try to be more specific about what does not work for you and make sure to document what you have tried.

[ValerioOniride]

I haven't tried Highlight.js, im using this .yml configuration:
markdown_extensions:

• pymdownx.highlight:
  anchor_linenums: true
  use_pygments: true
• pymdownx.inlinehilite
• pymdownx.snippets:
  base_path: ["overrides"]
• pymdownx.blocks.admonition
• pymdownx.arithmatex:
  generic: true
• footnotes
• pymdownx.blocks.details
• pymdownx.superfences
• pymdownx.mark
• pymdownx.keys
• attr_list
• pymdownx.emoji:
  emoji_index: !!python/name:material.extensions.emoji.twemoji
  emoji_generator: !!python/name:material.extensions.emoji.to_svg

The issue i'm facing is that i don't like the result of the codeblock highlight, could you help me setting up highlight.js to make a test with?

[alexvoss]

All you need is in the documentation but since we don't have an example in our example repository yet, I just put one together. You need to change the code block to the language you want.

9.5.18-code-highlight-javascript-example.zip

[squidfunk]

Converting to discussion, since this is essentially a customization request.

[kamilkrzyskow]

Hello @ValerioOniride,
considering that Unity itself doesn't bother highlighting it properly on their own docs, I would assume you need to make adjustments yourself. Also the MenuItem seems to be a built-in Unity thing, and ActiveEditorTracker seems to be your own defined class. Pygments doesn't process the code, it only lexes tokens and none of the above are defined in the base C# syntax.

Looking at the demo here the whole [MenuItem("MyMenu/Log Selected Transform Name")] is recognized as a Name.Attribute, so you could definitely extend the default lexer to change the behaviour to process the insides separately, but note that you'd have to define what keywords are special built-ins to highlight. Similarly, like I did it with the Gothic lexer here, but note that I didn't look at the base C# lexer, so perhaps this isn't the best approach.

I did a quick search for a Pygments Unity Lexer but found nothing, so you could be the first to make one 😃

I also tried the Highlight.js demo, and found that it did a better job with the Unity MenuItem example, properly tokenizing the [MenuItem("MyMenu/Log Selected Transform Name")] part.