Hi
when writing documentation for GEMOC we use asciidoc as it provides
higher level presentation support.
I terms of code highlighting most systems suport classic languages
(java, html, xml, etc) however in GEMOC we use and define a wider
variety of languages.
ocl, xtend, (xtend+k3), aql, ale, oclinecore, ecl, moccml for
example.
In the current documentation, I used a special tool chain to be able
to have local highlighter configuration : asciidoc to docbook ->
docbook to html add then add custom highlighting rule to this
docbook to html. (for example https://download.eclipse.org/gemoc/docs/nightly/index.html
supports ecl in the 2.2 section :-) )
This compilation chain is quite cumbersome and would be simplier if
we can just rely on asciidoctor.
Unfortunatly, even if it supports 5 hightlighter technologies (see https://asciidoctor.org/docs/user-manual/#available-source-highlighters
) none of them is locally configurable and require to do a pull
request to add a new language.
So my proposition is that we decide to use one of the 5
technologies and then progressively contribute our languages.
=> Do you have any preference between Coderay, highlightjs,
prettify, pygments, and rouge ?
=> once decided, does one of you wish to contribute too ? (AQL +
ALE -> Fabien ? ECL -> Julien ?, ... )
my preference goes to highlightjs or pygments (highlightjs because
it already supports 185 languages, and pygments because it support
both html and pdf, however pdf support is low priority for us)
Didier
not checked but an additionnal concern can also be the compatibility
of the highlighter with markdown used at github ?
--
Didier Vojtisek
SED Rennes - DiverSE Team - LogicA Team
Inria, Univ Rennes, CNRS, IRISA
Campus de beaulieu
35042 Rennes
02 99 84 75 07
|