[Top][All Lists]

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

Re: Use Markdown for NEWS file

From: John W. Eaton
Subject: Re: Use Markdown for NEWS file
Date: Mon, 4 Mar 2019 11:13:16 -0500
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.5.1

No objections from me.


On 3/4/19 7:29 AM, Kai Torben Ohlhus wrote:
Recently, I "Markdownified" the online version of the NEWS file and added some categories to avoid repetitive sayings like "... to be ML compatible.... will be removed from Octave 7...." which is boring to read:


Now I am able to read the changes on my smartphone without horizontal scrolling as well ;-)

Are there any objections against using Markdown for the NEWS file in general?  Octave already uses Markdown for the README file and the current style of the NEWS file is quite close to Markdown anyways.  This makes it easier to create a good looking news announcements without to much post-processing on the website.

By using a plain text editor the file is still readable [1] (even better if the editor supports Markdown-syntax highlighting).  The only drawback as with README is, that we cannot help the editor by adding a prefix like "NEWS.md".  This would violate the GNU Standard in automake [2].

If there are no objections, I would merge my NEWS-5.1.md <http://NEWS-5.1.md> changes with the stable branch (omitting some website related additions) and Markdownify the current default branch.


[1] https://hg.octave.org/web-octave/file/0bcf9964773c/NEWS-5.1.md
[2] https://www.gnu.org/software/automake/manual/automake.html#Strictness

reply via email to

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