Code annotations with Prism highlighting

[ghost]

We are using Prism highlighting because we have been unable to persuade the Pygments team to accept a grammar for the q programming language. Everything has worked smoothly, but if Pygments would support q, we would revert to minimise variation from the standard MM config.

I find the new code annotations feature does not work with Prism highlighting. Any prospect of that happening? (Or do you have any pull with the Pygments team?)

[facelessuser]

Even if Pygments doesn't support q, you could create your lexer and either pull request it, or just use it on the side. Pygments as a plugin system by which you can provide custom lexers.

[AjaniBilby]

Even if Pygments doesn't support q, you could create your lexer and either pull request it, or just use it on the side. Pygments as a plugin system by which you can provide custom lexers.
- @facelessuser

You mentioned that Pygments allows easily implementation of custom lexers, which it does as seen here - however this doesn't mention how you'd then add it into the MkDocs workflow, and more importantly in a way that Github actions will also have access to.

It seems like we'd need to specify the custom lexer we'd want to import within Python directly, but as far as I know, there are no hooks available to run our own Python during the initialisation of MkDocs

# For a lexer named CustomLexer
your_lexer = load_lexer_from_file(filename, **options)

[facelessuser]

You can implement some as I've done here. I then include them in my documentation requirements as seen here. They just get installed with my other requirements in GitHub actions and are available when I build the docs.

[facelessuser]

I purposely do not make my custom extensions available on PyPI, but you could make your own custom ones available there if that is desirable.

[AjaniBilby]

I'm not very used to the Python eco-system, but from my understanding, you're basically NPM requiring your own package which is hosted in a GitHub instead of in the package manager. Which would then mean two things from my understanding:

1. I would need to put my lexer(s) in a package, possibly their own repo
2. As far as I understand this would only install the packages, it wouldn't then load them when MkDocs runs, or bind them into the Pygments eco system - so from what I can see it would have no affect on the MkDocs highlighting.

[facelessuser]

you're basically NPM requiring your own package which is hosted in a GitHub instead of in the package manager

From a node perspective, this would kind of be the same, yes.

I would need to put my lexer(s) in a package, possibly their own repo

Yes, that is at least what I've done.

As far as I understand this would only install the packages, it wouldn't then load them when MkDocs runs, or bind them into the Pygments eco system.

Incorrect. If you do it properly, they are installed with entry points that Pygments recognizes and loads them automatically. https://github.com/facelessuser/pymdown-lexers/blob/master/setup.py#L6.

so from what I can see it would have no affect on the MkDocs highlighting

I'm pointing to an example that I literally use, so I can confirm it does in fact work. See here where I highlight CriticMarkup syntax:
https://facelessuser.github.io/pymdown-extensions/extensions/critic/#usage (see the "Markdown" tab in the examples).