[llvm-dev] [RFC] Markdown for documentation

[Philip Reames via llvm-dev]

Agreed.  Markdown is also nice for the github integration.  It might 
make some of our docs more easily discoverable.  (and maybe editable 
someday)


On 03/29/2018 01:34 PM, Reid Kleckner via llvm-dev wrote:
> If Sphinx consumes Markdown, great, let's do it.
>
> We can migrate docs from .rst to .md easily over time.
>
> On Thu, Mar 29, 2018 at 1:26 PM Michael Spencer via llvm-dev 
> <llvm-dev at lists.llvm.org <mailto: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.
>
>     - Michael Spencer
>     _______________________________________________
>     LLVM Developers mailing list
>     llvm-dev at lists.llvm.org <mailto:llvm-dev at lists.llvm.org>
>     http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
>
>
>
> _______________________________________________
> 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/20180329/853352bd/attachment.html>