Re: Syntax highlighting

[Urs Liska]

Am Dienstag, den 14.01.2020, 12:27 +0100 schrieb Federico Bruni:
> 
> Il giorno mar 14 gen 2020 alle 09:13, Craig Dabelstein 
> <address@hidden> ha scritto:
> > Hi all,
> > 
> > I'd like to add LilyPond syntax highlighting to highlight.js ( 
> > https://highlightjs.readthedocs.io/en/latest/ ) so that I can 
> > experiment with documentation tools such as mkDocs/readthedocs.
> > Does 
> > anyone have any experience with this? Would it just be a matter of 
> > getting one of the current syntax packages (such as 
> > https://github.com/yrammos/SubLilyPond or 
> > https://github.com/yrammos/AtLilyPond , and trying to modify them?
> > 
> > 
> 
> I don't have any experience with highlight.js.
> Some years ago I started writing a Pygments definition for LilyPond
> but 
> then I gave up or simply forgot about it.
> 
> The Sublimetext and Atom packages might be useful as a reference, but
> I 
> guess that highlight.js will need its own syntax so you'd better
> start 
> from scratch.
> 
> The problem with syntax highlighting is maintainance. LilyPond
> syntax 
> changes and a manually compiled list must be updated manually for
> every 
> new stable release.
> 
> See also python-ly:
> https://github.com/frescobaldi/python-ly/blob/master/ly/words.py
> 

I'm not sure where and how, but there is also a substantial part of
python-ly's knowledge that is retrieved directly from LilyPond (either
from the sources or by running some LilyPond code). As far as I know
python-ly is the most comprehensive syntax highlighting solution on the
market (although still 2.18.2), and I think it would be good to find a
way use that “knowlegde” to generate syntax highlighting for arbitrary
other highlighters from that set of data.

> 
> Personally I'd be more interested in adding lilypond to Pygments.
> Pygments can be easily exported to chroma¹ (for Hugo² static site 
> generator).
> And it seems Pygments may be used also in Mkdocs, see this
> discussion:
> https://github.com/mkdocs/mkdocs/issues/1588

Pygments is also what Pandoc uses for its syntax highlighting, so that
would also make sense for that (e.g. generating PDF documentation from
Markdown).

Urs

> 
> ¹ https://github.com/alecthomas/chroma
> ² https://gohugo.io/content-management/syntax-highlighting/
> 
> 
> 
>