dmd Feature Request: Conform to Markdown Linters

It would be really cool for this plugin's output to be able to conform to markdown linters, such as this one https://github.com/DavidAnson/markdownlint.

May 06 '20 15:05 D-Marc1

jsdoc2md outputs Github-flavoured markdown.. does the linter above support GFM?

May 07 '20 15:05 75lb

Yes, I believe. I don't know all the rules fully by heart, so it's possible there might be a few rules it doesn't. But it does seem so from me testing my own MD file.

May 07 '20 19:05 D-Marc1

If you have GFM issues, you could always try the jsdoc2md --no-gfm flag..

Aug 27 '24 12:08 75lb

I personally consider this low priority - it would be a considerable amount of work for not enough meaningful gain.. happy to accept PRs though. Will close for now as it's not a feature in demand.

Aug 31 '24 23:08 75lb

Re-opening.. it may take some time (given the complexity of the existing handlebars solution) but I will aspire to at least pass a GFM linting test.. I have made a start.

I'm not sure how many of the existing linting errors, for example those that complain about embedded HTML, can be fixed but I will take a look.. When this tool was created in 2014, things like HTML links were necessary to support both Github and the NPM website but things may have changed since.

Sep 08 '24 16:09 75lb