search

jsdoc2md / dmd

The default output template for jsdoc2md
MIT License
39 stars 49 forks source link

Feature Request: Conform to Markdown Linters #101

Open D-Marc1 opened 4 years ago

D-Marc1 commented 4 years ago

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.

75lb commented 4 years ago

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

D-Marc1 commented 4 years ago

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.

75lb commented 2 months ago

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

75lb commented 2 months ago

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.

75lb commented 2 months ago

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.