[llvm-dev] [RFC] Markdown for documentation

[Adrian Prantl via llvm-dev]

I don't like the fact that there are so many different Markdown versions especially when compared to RST, but it does seem that Markdown has become the more popular format. If our tooling supports it and we document what dialect we use (and perhaps even have some form of ninja check-docs to enforce it) I think that this makes sense.

-- adrian

> On Mar 29, 2018, at 1:25 PM, 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 <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.
> 
> - Michael Spencer
> _______________________________________________
> LLVM Developers mailing list
> llvm-dev at lists.llvm.org
> http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev

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