[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Markdown processor recommendation?

From: Kai Torben Ohlhus
Subject: Re: Markdown processor recommendation?
Date: Tue, 22 Oct 2019 12:51:00 +0900
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.1.1

On 10/22/19 11:59 AM, Rik wrote:
> After clearing that hurdle, I reviewed the resulting HTML and there were a
> few other places that didn't render well.  I fixed those up here
> (https://hg.savannah.gnu.org/hgweb/octave/rev/207e0bc53cdd), although I bet
> the double spaces at the end of one of the lines--which are required to
> introduce a line break in HTML--get deleted in the future by someone intent
> on cleaning trailing spaces.
> --Rik

Regarding the double spaces, you are right, this is "dangerous".  My
editor is likely to mess this up, because of automatic removal of
trailing white space.  A better solution might be to either use a sub list:

-    `Octave:colon-complex-argument`   : when any arg is complex
-    `Octave:colon-nonscalar-argument` : when any arg is non-scalar
+  - `Octave:colon-complex-argument`   : when any arg is complex
+  - `Octave:colon-nonscalar-argument` : when any arg is non-scalar

Or to use 8 spaces for indention to automatically get a code block [1]:

-    `Octave:colon-complex-argument`   : when any arg is complex
-    `Octave:colon-nonscalar-argument` : when any arg is non-scalar
+       Octave:colon-complex-argument   : when any arg is complex
+       Octave:colon-nonscalar-argument : when any arg is non-scalar

This might also apply for

-     `format long e uppercase loose`
+       format long e uppercase loose

There is per se no need to use inline code markers.  I used only 6
spaces, because for the Octave website, Jekyll translates Markdown using
Kramdown, for which this indention is sufficient...  Nasty details.

My recent approach was to overhaul the document while a release happens,
to have a nice page on the Octave website as well.  Thus at the moment I
do not care too much for the content formatting.

On 10/22/19 10:28 AM, Carnë Draug wrote:
> On Mon, 21 Oct 2019 at 22:10, Kai Torben Ohlhus <address@hidden>
>> [...]
>> Markdown is a super plain robust standard,
>> [...]
> Markdown is not standardised.  There are several markdown flavours
> with different syntax differences, and even more implementations.
> I guess it is fine for our simple needs in the NEWS file though.

You are right.  Please read "super plain robust markup,".  This was what
I tried to say.


[1] https://daringfireball.net/projects/markdown/syntax#list

reply via email to

[Prev in Thread] Current Thread [Next in Thread]