Syntax highlighting - eyes needed

[finanalyst]

@Raku/core We have changed the syntax highlighter from one developed for the atom editor (atom-perl6-highlighter) to a Raku based one (Rainbow).

• colouration request. Rainbow offers more categories that can be colourised, eg three separate regex categories, separate delimiter categories.
• The colours chosen for the moment are the same as before, but the same colour is used for duplicate categories. Ideally each category should be a different colour (more generally styling).
• Although the styling of each category is done via CSS, categories can be styled using colour, font, font decoration etc. However, that would need a bit more refactoring of the SCSS, eg adding variables for font as well as colour.
• Please offer suggestions. (Values are needed for the light and dark themes separately)
• concrete suggestions can be made using a PR changing the following files:
  • <repo root>/Website/plugins/rainbow/scss/rainbow-light.scss
  • .../scss/rainbow-dark.scss
  • the relevant colour values for the highlighting are assigned to SCSS variables $code-..... and start at about line 15.

Known problems:

• when the RakuDoc source has =for code :allow<C> or other value in 'allow', the :allow option is not respected.
  • I think that only the Pod.rakudoc file still retains ':allow'
  • in the discussions about RakuDoc v2, the allow option is difficult to implement in combination with syntax highlighting, and needs to be handled separately. This will be developed in due course. The problem existed with the previous highlighter too.
• Rainbow does not handle metadata options in RakuDoc blocks correctly as yet. The priority for addressing this flaw is considered low at present.
  • It is not known yet whether this affects any code snippets in the main sources. Help to determine this would be appreciated.

[patrickbkr]

• in the discussions about RakuDoc v2, the allow option is difficult to implement in combination with syntax highlighting, and needs to be handled separately. This will be developed in due course. The problem existed with the previous highlighter too.

Actually I've already done something similar in Rainbow with quote adverbs already (see the Adverbs section here). This shouldn't be too hard to get right. Can you provide a quick primer how this option is meant to work exactly? (Ideally create a ticket.)

[finanalyst]

Quick smartphone response to Patrick.

=for code :allow<B I>
my $var = 'filename.conf'.B<IO>.I<slurp>(:close);
my $strng = 'This is B<bold> but this is NOT U<underlined>';

Normal para  in Rakudoc source.

On Mon, 11 Nov 2024, 13:10 Patrick Böker, @.***> wrote:

• in the discussions about RakuDoc v2, the allow option is difficult to implement in combination with syntax highlighting, and needs to be handled separately. This will be developed in due course. The problem existed with the previous highlighter too.

Actually I've already done something similar in Rainbow with quote adverbs already (see the Adverbs section here https://git.sr.ht/~patrickb/Rainbow/tree/main/item/t/test-data/string.rakumod). This shouldn't be too hard to get right. Can you provide a quick primer how this option is meant to work exactly? (Ideally create a ticket.)

— Reply to this email directly, view it on GitHub https://github.com/Raku/doc-website/issues/419#issuecomment-2468143967, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACYZHGOIAJ63GZC7CBKDDT2ACUDJAVCNFSM6AAAAABRO7STZOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINRYGE2DGOJWG4 . You are receiving this because you authored the thread.Message ID: @.***>