Markdown Linter - Compliance
Closed this issue · 2 comments
Hi,
thank you for the hint. There is also often MD033.
Let me explain, why I am doing it against common Markdown rules:
MD003 - Mixed heading styles
This is because SQL*Plus can be problematic when using the hash sign as the first character in a line. Therefore I use setext style headers in the Markdown comments. Unfortunately there are only two levels of headers with setext. If you need more levels you need to use ATX style headers in your code docs. I am personally prefer not to have more then two levels of headers in the docs - for me I do not get those MD003 warnings.
MD012 - Multiple consecutive blank lines
I use this to structure a little bit the generated code to be more readable in the pure text form. Two blank lines means a new section starts and inside this section I generate only single blank lines.
MD033 - Inline HTML
I use this to add a table of contents at the top of the documents and use HTML code to build the headers.
What can we do?
I don't want to change this for the mentioned reasons. To be compliant with the markdown linter I can add a hint at the top of the generated documents to disable these three rules for the Markdown linter.
Hope this is ok for you.
Best regards
Ottmar