<div dir="ltr"><div class="gmail_extra"><div><div class="gmail_signature">On Fri, Mar 30, 2018 at 1:56 AM, David Chisnall <span dir="ltr"><<a href="mailto:theraven@theravensnest.org" target="_blank">theraven@theravensnest.org</a>></span> wrote:<br></div></div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><span class="gmail-">On 29 Mar 2018, at 21:25, Michael Spencer via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org">llvm-dev@lists.llvm.org</a>> wrote:<br>
><br>
> There's been some desire recently to start writing documentation in Markdown instead of reStructuredText. I put up a [patch](<a href="https://reviews.llvm.org/D44910" rel="noreferrer" target="_blank">https://reviews.llvm.<wbr>org/D44910</a>) for that, but we should figure out a policy on how we want our documentation written first.<br>
><br>
> 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.<br>
><br>
> My suggestion is that we don't touch the existing documentation, but encourage new documentation to be written in Markdown+Sphinx extensions.<br>
<br>
</span>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).<br>
<span class="gmail-HOEnZb"><font color="#888888"><br>
David<br>
<br>
<br>
</font></span></blockquote></div><br></div><div class="gmail_extra">It's not GitHub markdown, but it does support ``` [language]. See <a href="http://recommonmark.readthedocs.io/en/latest/auto_structify.html">http://recommonmark.readthedocs.io/en/latest/auto_structify.html</a> for the extensions.</div><div class="gmail_extra"><br></div><div class="gmail_extra">

<div style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:small;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial"><div class="gmail_signature">- Michael Spencer</div></div><br class="gmail-Apple-interchange-newline">

<br></div><div class="gmail_extra"><br></div></div>