Code annotation for a custom language?

[hellt]

Hi @squidfunk
I added a custom syntax highlighter to mkdocs-material, and I wonder if I can make code annotations to work with this custom lang?
How/where do I say which char mkdocs-material should consider a comment to make the following notation to work?

#(1)!

[squidfunk]

Use one of the following CSS classes:

mkdocs-material/src/assets/javascripts/components/content/annotation/list/index.ts

Line 74 in 48e8b2b

for (const el of getElements(".c, .c1, .cm", container)) {

[hellt]

ahh, damn, my pygments parser failed to mark #() as a comment element.
Gotcha, thanks, will fix that and retry.

[squidfunk]

With Insiders 4.32.0, code annotations can now be placed anywhere. Material for MkDocs can be configured per-language to allow for code annotations in other lexemes than comments, e.g. strings. See the documentation on custom selectors.

[hellt]

thanks @squidfunk
this is cool. It might be worthwhile adding a note, that for custom lexemes the code annotation syntax stays unchanged (except ! is not needed)

e.g.

{
  "key": "value (1)"
}

[squidfunk]

Agree, I still need some time to rework the documentation a little. Wanted to push this out first. ! may be useful at times, for example when you want to add inline bash annotations:

docker "(1)!" run squidfunk/mkdocs-material

This would render as docker (+) run squidfunk/mkdocs-material, as opposed to docker "(+)" run squidfunk/mkdocs-material when the ! would be omitted. Note that this breaks examples when JavaScript is not available (= too slow). We'll see how we can mitigate that in the future, but it should be rarely relevant. Printing works as well.