[infinispan-dev] code highlight in github/asciidoc

[Mircea Markus]

On Nov 4, 2013, at 10:40 AM, Galder Zamarreño <galder at redhat.com> wrote:

> I find the lack of syntax highlighting a small thing TBH. You can always take the code, paste it in a gist and put the link in the design document.

As long as you do that, +1. 
The document is read way more many times than written and I think syntax highlighting really helps with redability.

> 
> I do however find asciidoc much better for structuring complex documentation. For example, adding a bullet or numbered point section with code/quote sections inside.

Does that actually work on github? asciidoc also provides syntax highlighting, but the github renderer doesn't take it into account. 

> 
> Personally, I'd leave it up to individual contributors to decide what they prefer in terms of markup language, although I agree that a preferable markup language should be defined in the documentation.

Sure, both of them are pretty straight forward. Let's used both then (document updated).

> 
> Cheers,
> 
> On Oct 30, 2013, at 8:26 PM, Mircea Markus <mmarkus at redhat.com> wrote:
> 
>> 
>> On Oct 30, 2013, at 4:49 PM, Manik Surtani <manik at infinispan.org> wrote:
>> 
>>> I only suggested AsciiDoc to be consistent with the markup used for our documentation.  Having two different markup syntaxes in use for the project could get annoying... but yes, I agree that the lack of syntax highlighting on the wiki can be even more annoying.
>> 
>> If it's only that let's just use markup as it is more mature on github. I'll update the docs to state that.
>> 
>> Cheers,
>> -- 
>> Mircea Markus
>> Infinispan lead (www.infinispan.org)
>> 
>> 
>> 
>> 
>> 
>> _______________________________________________
>> infinispan-dev mailing list
>> infinispan-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/infinispan-dev
> 
> 
> --
> Galder Zamarreño
> galder at redhat.com
> twitter.com/galderz
> 
> Project Lead, Escalante
> http://escalante.io
> 
> Engineer, Infinispan
> http://infinispan.org
> 
> 
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev

Cheers,
-- 
Mircea Markus
Infinispan lead (www.infinispan.org)