[llvm-dev] [RFC] Markdown for documentation

[Michael Spencer via llvm-dev]

On Fri, Mar 30, 2018 at 1:56 AM, David Chisnall <theraven at theravensnest.org>
wrote:

> On 29 Mar 2018, at 21:25, Michael Spencer via llvm-dev <
> llvm-dev at lists.llvm.org> wrote:
> >
> > There's been some desire recently to start writing documentation in
> Markdown instead of reStructuredText. I put up a [patch](
> https://reviews.llvm.org/D44910) for that, but we should figure out a
> policy on how we want our documentation written first.
> >
> > The desire to use Markdown comes mostly from it being simpler, and
> having much wider adoption.  It does lack some of the feature that
> reStructuredText has; however, the recommonmark plugin for Sphinx adds
> extensions for most of them and has an escape to RST when all else fails.
> >
> > My suggestion is that we don't touch the existing documentation, but
> encourage new documentation to be written in Markdown+Sphinx extensions.
>
> Does the plugin support GitHub-flavoured Markdown?  Most of the annoying
> limitations of Markdown are fixed in the GitHub version (particularly, the
> ```[language] blocks make documenting code much easier).
>
> David
>
>
>
It's not GitHub markdown, but it does support ``` [language]. See
http://recommonmark.readthedocs.io/en/latest/auto_structify.html for the
extensions.

- Michael Spencer
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20180402/d2ba8f77/attachment.html>