Author's Guide: Switch to Highlight #51
Labels
📖 Author's Guide
Issue relating to "The Alan Author's Guide"
🕑 pending decision
Issue requires decisions by one or more maintainers
👑 HTML Format
Issues with conversion to HTML format
🔨 Highlight
Tool: Highlight (syntax highlighter)
⭐ syntax highlighting
Topic: Syntax Highlighting
Milestone
Currently the are no impediments for not using Highlight for the Alan Author's Guide, for it doesn't it uses callouts anywhere (these being what prevents using Highlight with Asciidoctor — See #36 on this).
So, since this book is still in the making, the question really boils down to whether we are planning to use callouts or not in it! Callouts are indeed a cool feature, especially in these type of documents which contain lots of code examples, for they introduce a nice notes-like system for source code.
Eventually, the Highlight extension will support callouts, but right now it doesn't. Should we just keep using Highlight.js, and enjoy callouts? Or should we rather switch to Highlight and postpone using callouts in the book until they are supported?
It's a matter of choosing which one should get the priority: the highlighter toolchain or the callouts feature?
Since this is Thomas's book, the choise belongs to him really...
The text was updated successfully, but these errors were encountered: