Re-Write Highlight Extension for Asciidoctor 2.0

[tajmone]

Problem

The current Highlight TreeProcessor extension employed in this project to integrate Highlight into the Asciidoctor toolchain is based on very old code and has a number of limitations:

• /assets/adoc/highlight-treeprocessor_mod.rb

Solution

• The whole Highlight extension needs to be re-written from scratch adopting the new SyntaxHighlighter API for Asciidoctor 2.0. For details, see:
  • asciidoctor/asciidoctor-extensions-lab#99
  • asciidoctor/asciidoctor#299

The problem here is that I dont' have enough knowledge of Ruby nor the Asciidoctor API to do it — I've tried many times over, without results (see: alan-if/alan-docs#36).

Any help from someone fluent in Ruby is appreciated.

Known Limitations

In order of severity:

• Doesn't support callouts in code blocks.
• Code blocks inside table cells is not highlighted.
• Limited and buggy support for substitutions in code blocks via the subs attribute.
• Risk of becoming unusable in the future, if the API 2.0 breaks support for legacy extensions.

Reference Links

• Help With Callouts: Any Examples? asciidoctor/asciidoctor-extensions-lab#99
• resolves #115 add option to use font icons asciidoctor/asciidoctor#299
• Highlight repo: /extras/AsciiDoc/ — AsciiDoc assets for Highlight.

Other issues were I discuss this topic:

• Enable Callouts in AsciiDoc Extension for Highlight alan-if/alan-docs#36
• Switch to Highlight alan-if/alan-docs#49