[windup-dev] Fwd: Re: GitHub problem rendering AsciiDoc lists

Lincoln Baxter, III lincolnbaxter at gmail.com
Fri Sep 12 11:48:08 EDT 2014


GitHub uses Asciidoctor to render their asciidoc files.

One major point of AsciiDoctor is that it allows you to customize your
rendering. If we want custom CSS, we should not use Github Wiki directly,
and instead use something like Redoculous, which is what the Forge website
uses to render its docs and display them in its own CSS:

http://redoculous-lincolnbaxter.rhcloud.com/api/v1/preview?repo=https://github.com/windup/windup.wiki.git&path=/Rules:%20Rules%20Development%20Guide.asciidoc&ref=master

(looks like I need to fix a bug in some of the link handling, but you
should get the idea. It lets you embed docs directly from github into a
webapp: http://forge.jboss.org/document/develop-an-addon )

~Lincoln





On Thu, Sep 11, 2014 at 5:17 PM, Ondrej Zizka <ozizka at redhat.com> wrote:

>  I posted it to AsciiDoc. But they don't share my opinion that <p> in <li>
> is a wrong idea.
> https://groups.google.com/forum/#!topic/asciidoc/BF9HlACuNjE
>
> They have an unfortunate mix of "DocBook legacy" and forward compatibility.
> But it's a bit configurable.  Dan wrote:
>
> It's also pretty each to change by hacking the html5.conf file:
>
>  ----
>  [paragraph]
> {title?<div class="title">{title}</div>}
>  <p class="paragraph{role? {role}}{unbreakable-option? unbreakable}"{id?
> id="{id}"}>
> |
> </p>
>  ----
>
> We could ask GitHub to change that for li I guess.
> Or, as I suggested earlier, find out if GitHub allows to apply per-project
> CSS.
>
> Ondra
>
>
>
> On 11.9.2014 22:23, Sande Gilda wrote:
>
> This is interesting. GitHub uses Asciidoctor to render the asciidoc files!
>
> Ondra, where did you report this issue? If you didn't report it to
> Asciidoctor, I will.
>
>
> -------- Original Message --------  Subject: Re: GitHub problem rendering
> AsciiDoc lists  Date: Thu, 11 Sep 2014 10:08:00 -0700  From: Jess Hosman
> (GitHub Staff) <support at github.com> <support at github.com>  To: Sande Gilda
> <sgilda at redhat.com> <sgilda at redhat.com>
>
> Hi Sande,
>
> Thanks for your patience. After some digging, it looks like we use the third party tool Asciidoctor [1] for the conversion, which is where the extra `<p>` tags are coming from. I'd recommend opening an issue in the Asciidoctor repo about this. Once changes are made there, we should be able to pull them into GitHub.
>
> Cheers,
> Jess
>
> [1]: https://github.com/asciidoctor/asciidoctor
>
>
>
>
>
> _______________________________________________
> windup-dev mailing listwindup-dev at lists.jboss.orghttps://lists.jboss.org/mailman/listinfo/windup-dev
>
>
>
> _______________________________________________
> windup-dev mailing list
> windup-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/windup-dev
>



-- 
Lincoln Baxter, III
http://ocpsoft.org
"Simpler is better."
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/windup-dev/attachments/20140912/71d7be4e/attachment-0001.html 


More information about the windup-dev mailing list