[llvm-dev] [RFC] Markdown for documentation

[Jessica Paquette via llvm-dev]

I’d love Markdown documentation. It’s easy to read when rendered, easy to read + navigate from a bare-bones text editor, pleasant to write, and has wide adoption. I’m a fan.

(If there are any serious missing features, we could probably look into something like Markdeep in the future, which is compatible with Markdown syntax but adds some extra functionality for documentation, writing books, etc.)

- Jessica

> 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/061eec03/attachment.html>