search

ms1963 / TechnicalDebtRecords

Tool and documentation for systematically using Technical Debt Records
MIT License
20 stars 4 forks source link

Stick to markdown best practices #2

Open trivialkettle opened 3 hours ago

trivialkettle commented 3 hours ago

Hi, The markdown exporter does not follow the heading best practices described here: https://www.markdownguide.org/basic-syntax/#heading-best-practices

You should also put blank lines before and after a heading for compatibility.

Any reason for this?

ms1963 commented 2 hours ago

Dear trivialkettle,I was not aware of these issues. Thank you for pointing me to the URL. I will read the guidelines and provide a mapping without these problems. Unfortunately, I couldn‘t find a high quality Go package to programmatically create Markdown. So I handcrafted the code myself.Kind Regards     MichaelAm 14.10.2024 um 15:51 schrieb trivialkettle @.***>: Hi, The markdown exporter does not follow the heading best practices described here: https://www.markdownguide.org/basic-syntax/#heading-best-practices

You should also put blank lines before and after a heading for compatibility.

Any reason for this?

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: @.***>