Hi, When building the documentation (ant documentation), all readme files included in the documentation are parsed as markdown (see flexmark task in ant) and converted to html. This works well, although not everything is markdown. If you have a plain readme file it would still parse as valid markdown and HTML output looks fine, so Erik's problem with markdown isn't one.
Uwe Am November 10, 2019 4:00:21 PM UTC schrieb Marcus Eagan <[email protected]>: >Most README files in contemporary open source projects are Markdown >because >of the formatting features. I personally favor convention over ease of >use >in this case. > >Marcus Eagan > >On Sun, Nov 10, 2019, 8:58 AM Erick Erickson <[email protected]> >wrote: > >> Personally I’d make them text files. The last thing I want to do is >make >> reading/updating these have a barrier to entry. We should save >formatting >> for the ref guide and/or Wiki. >> >> Best, >> Erick >> >> > On Nov 10, 2019, at 1:01 AM, Man with No Name ><[email protected]> >> wrote: >> > >> > Hey folks, >> > I have been looking into the solr/lucene source code, and the first >> thing caught my eye was the different Readme files. All the files had >> different file and text format. What do you guys think about making >all the >> readmes to markdown file rather than text files, and a standard >template? >> > >> > >> > -- >> > Regards: >> > Pinkesh Sharma >> >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: [email protected] >> For additional commands, e-mail: [email protected] >> >> -- Uwe Schindler Achterdiek 19, 28357 Bremen https://www.thetaphi.de
