<div dir="ltr"><div dir="ltr">On Wed, Aug 24, 2022 at 9:08 AM Fabian Arrotin <<a href="mailto:arrfab@centos.org">arrfab@centos.org</a>> wrote:<br></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">For that reason, some SIGs (including Infra SIG), moved already their <br>
doc to markdown format, easy to write/review through PR and <br>
automatically rendered.<br></blockquote><div><br></div><div>I'd just like to throw out a vote for using a more powerful markup language such as asciidoc with better support for templating, linking, and overall a more robust experience when it comes to writing documentation.</div><div><br></div><div>For example we write our upstream documentation for STF in asciidoc (<a href="https://github.com/infrawatch/documentation">https://github.com/infrawatch/documentation</a>) and upon merge to the main branch, is auto-rendered (<a href="https://github.com/infrawatch/documentation/blob/master/.github/workflows/main.yml#L17">https://github.com/infrawatch/documentation/blob/master/.github/workflows/main.yml#L17</a>) and published into a static site (<a href="https://infrawatch.github.io/documentation/">https://infrawatch.github.io/documentation/</a>).</div><div><br></div><div>I understand the desire for markdown since most people are generally able to guess the syntax, but for a little bit of extra effort asciidoc has been a really enjoyable experience from the extra power and rendering capabilities it provides (while maintaining the ability to review and preview content out of git both remote and locally).</div><div><br></div><div>Thanks</div><div>Leif.</div></div></div>