Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Conform to Markdown Linters #101

Open
D-Marc1 opened this issue May 6, 2020 · 5 comments
Open

Feature Request: Conform to Markdown Linters #101

D-Marc1 opened this issue May 6, 2020 · 5 comments

Comments

@D-Marc1
Copy link

D-Marc1 commented May 6, 2020

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.

@D-Marc1 D-Marc1 changed the title Feature Request: Conform to Makrdown Linters Feature Request: Conform to Markdown Linters May 6, 2020
@75lb
Copy link
Member

75lb commented May 7, 2020

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

@D-Marc1
Copy link
Author

D-Marc1 commented May 7, 2020

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
Copy link
Member

75lb commented Aug 27, 2024

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

@75lb
Copy link
Member

75lb commented Aug 31, 2024

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 75lb closed this as completed Aug 31, 2024
@75lb
Copy link
Member

75lb commented Sep 8, 2024

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.

@75lb 75lb reopened this Sep 8, 2024
@75lb 75lb transferred this issue from jsdoc2md/jsdoc-to-markdown Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants