[windup-dev] Asciidoc - lists

Pete Muir pmuir at redhat.com
Tue Sep 9 06:39:26 EDT 2014


The big advantages of asciidoc are:

* more comprehensive markup (e.g. tables, definition lists are supported as standard)
* generation of pdf and epub is part of the standard toolchain

Markdown is great for short docs, but I quickly ran in to the limitations when building more complex documents.

GitHub’s support for asciidoc wasn’t great to start with, but I think the fixed it more recently. Before you abandon it, point me at the problems, I can take a quick look.

I prefer asciidoc links as you just do link:http://redhat.com[Red Hat’s website]. I find this much easier to remember than the weird []() syntax in markdown.

On 9 Sep 2014, at 01:23, Sande Gilda <sgilda at redhat.com> wrote:

> I'll change everything back to Markdown later this week. Ondra, in the 
> meantime, you can work in Markdown.
> 
> On 09/08/2014 08:12 PM, Brad Davis wrote:
>> I personally leveraged Markdown because it worked.  Asciidoc a while ago did not.  I noticed when things moved to Asciidoc, the images in the docs broke.
>> 
>> Brad Davis
>> Red Hat Consulting
>> Email: bdavis at redhat.com | c: 980.226.7865 | http://www.redhat.com
>> 
>> 
>> ----- Original Message -----
>> From: "Ondrej Zizka" <ozizka at redhat.com>
>> To: "Sande Gilda" <sgilda at redhat.com>, "Windup-dev List" <windup-dev at lists.jboss.org>
>> Sent: Monday, September 8, 2014 7:58:20 PM
>> Subject: Re: [windup-dev] Asciidoc - lists
>> 
>> For the record: I don't strongly prefer either, only that I only touched
>> few things in AsciiDoc, and:
>>   1) certain constructs are quite less readable -> editable in the
>> source text (e.g. links)
>>   2) the render results are not satisfactory - things like a bold text
>> in a lists are not properly implemented on whatever GitHub uses.
>> 
>> Ondra
>> 
>> 
>> On 9.9.2014 01:17, Sande Gilda wrote:
>>> Hi all,
>>> 
>>> Ondra asked me about the advantages of AsciiDoc over Markdown. I
>>> really don't know, but I do remember Pete saying AsciiDoc would be
>>> better for the quickstart README files long ago. And I believe Drupal,
>>> the new host for documentation, supports AsciiDoc.
>>> 
>>> TBH, I don't feel strongly about sticking with AsciiDoc. If no one can
>>> come up with a good reason for sticking with it, I'm fine with going
>>> back to Markdown if it's easier for everyone.
>>> 
>>> So, AsciiDoc advocates, please speak up now.
>>> 
>>> Thanks,
>>> Sande
>>> 
>>> On 09/08/2014 06:29 PM, Sande Gilda wrote:
>>>> Hi Ondra,
>>>> 
>>>> You're asking me? ;-)
>>>> 
>>>> I'm totally new to asciidoc. I'll research it and see what I can find
>>>> out.
>>>> 
>>>> Thanks,
>>>> Sande
>>>> 
>>>> On 09/08/2014 06:13 PM, Ondrej Zizka wrote:
>>>>> Hi Sande,
>>>>> 
>>>>> is there any way to prevent asciidoc put <p> to each <li>? Makes the
>>>>> list tall and breaks the whole page layout.
>>>>> 
>>>>> Thanks,
>>>>> Ondra
>> _______________________________________________
>> windup-dev mailing list
>> windup-dev at lists.jboss.org
>> https://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




More information about the windup-dev mailing list