On Mon, Aug 7, 2017 at 2:03 AM, Pavel Roskin <plroskin@xxxxxxxxx> wrote: > Hello! > > On Sun, Aug 6, 2017 at 6:28 PM, Christopher Li <sparse@xxxxxxxxxxx> wrote: >> I want to use some mark down format for the document >> of sparse. > > It would be great to have more sparse documentation! OK, if you have more wish list what area of sparse you want to have. I can add that to my illusion list of sparse projects. >> rST Cons (for me): >> - I don't know rST at all. I need to learn it. >> - github does not recognized rST naturally. > > Not true for that point: > https://github.com/torvalds/linux/blob/master/Documentation/process/submitting-patches.rst Oh, I did not know that. Thanks for pointing it out. > >> MarkDown Pros: >> - More friendly to web. > > What does it mean exactly? Both should be convertable to HTML. Mark Down can embed html tags easier. If you only care about using Mark Down in the web, you can do some thing like this: Disclaimer: I haven't try it myself though, I believe every thing I read on the internet :-) # Heading 1 <div class="something" markdown="1"> ## Heading 2 Some **bold** text. </div> > I would say go with rST unless the major potential contributors insist > on Markdown. Capturing the knowledge is more important than selecting > the format. The format can be changed if a "wrong" choice is made. So far we have 2 on MD (Josh strongly). You are on reStructuredText. I just did a google trends comparing keyword "Markdown" and "reStructuredText" It seems "Markdown" is overwhelming more popular then "reStructuredText". If I try "RST" then "RST" is slightly ahead of "Markdown", but mostly due to false positives. Google "RST" most result are not "reStructuredText" related. I think I will go with MarkDown for now. You are right the content is the most important, not the format. Chris -- To unsubscribe from this list: send the line "unsubscribe linux-sparse" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
