[infinispan-dev] Code examples in multiple languages

Galder Zamarreño galder at redhat.com
Mon Sep 25 11:44:51 EDT 2017


I asked Dan Allen et al on twitter [2].

Spring has developed a similar plugin [3] and it appears to be included in [4].

Cheers,

[2] https://twitter.com/galderz/status/910848538720038913
[3] https://docs.spring.io/spring-restdocs/docs/current/reference/html5/#getting-started-build-configuration
[4] https://github.com/spring-io/spring-asciidoctor-extensions

> On 20 Sep 2017, at 21:17, Tristan Tarrant <ttarrant at redhat.com> wrote:
> 
> One thing that I wish we had is the ability, when possible, to give code 
> examples for our API in all of our implementations (embedded, hotrod 
> java, c++, c#, node.js and REST).
> 
> Currently each one handles documentation differently and we are not very 
> consistent with structure, content and examples.
> 
> I've been looking at Slate [1] which uses Markdown and is quite nice, 
> but has the big disadvantage that it would create something which is 
> separate from our current documentation...
> 
> An alternative approach would be to implement an asciidoctor plugin 
> which provides some kind of tabbed code block.
> 
> Any other ideas ?
> 
> 
> Tristan
> 
> [1] https://lord.github.io/slate/
> -- 
> Tristan Tarrant
> Infinispan Lead
> JBoss, a division of Red Hat
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev

--
Galder Zamarreño
Infinispan, Red Hat




More information about the infinispan-dev mailing list