From csardi.gabor at gmail.com  Sat May 23 15:25:57 2015
From: csardi.gabor at gmail.com (=?UTF-8?B?R8OhYm9yIENzw6FyZGk=?=)
Date: Sat, 23 May 2015 09:25:57 -0400
Subject: [Rd] NEWS.md support on CRAN
In-Reply-To: <55606F19.3080106@gmail.com>
References: <4819669E-8260-47B0-96BF-DC2B29E6BE21@me.com>
	<555FD2FE.8050600@gmail.com>
	<21856.13500.513608.759602@fangorn.hornik.net>
	<55606F19.3080106@gmail.com>
Message-ID: <CABtg=KkjFu7Jn8xJqQjyn5bRD8nJG_aJ-QS6ET4BY+ic_d3SBw@mail.gmail.com>

On Sat, May 23, 2015 at 8:14 AM, Duncan Murdoch <murdoch.duncan at gmail.com>
wrote:
[...]

> I think the harder problem is display.  CRAN can run pandoc, but can
> users who install the package from source?  I would expect some obscure
> platforms (like Windows ;-) would not have it available.
>
[...]

I don't think pandoc is the best way to go with NEWS.md (and README.md,
actually). I would be surprised if many package maintainer built their
NEWS/README files with pandoc. They just look at them at GitHub (or another
similar service).

GitHub has API for building HTML from MarkDown:
https://developer.github.com/v3/markdown/
It can build GitHub-flavored MarkDown, in which case you get links to
GitHub issues, etc. or just plain MarkDown, like a GitHub README.

If you don't want to rely on their service, then there are a multitude of
lightweight MarkDown parsers available, e.g.
https://github.com/markdown-it/markdown-it is a good one IMO.

Pandoc is great for vignettes, but you don't need its full power for
READMEs and especially not for NEWS files. In fact most NEWS.md files look
good as text.

Gabor

	[[alternative HTML version deleted]]



[Rd] NEWS.md support on CRAN
=?UTF-8?B?R8OhYm9yIENzw6FyZGk=?=