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

Include markdownlint-cli2 as a valid markdown formatter #521

Open
ns-rse opened this issue Nov 19, 2024 · 2 comments
Open

Include markdownlint-cli2 as a valid markdown formatter #521

ns-rse opened this issue Nov 19, 2024 · 2 comments

Comments

@ns-rse
Copy link

ns-rse commented Nov 19, 2024

Brilliant tool, thanks for building and sharing it.

I found our repository AFM-SPM/TopoStats:main failed on a few things, one of which was using a [PC180](https://learn.scientific-python.org/development/guides/style#PC180): Uses a markdown formatter.

We do use prettier in our .pre-commit-config.yaml but via pre-commit/mirrors-prettier which I'll change to rbubley/mirrors-prettier.

However, we also lint our Markdown with markdownlint-cli2 and I was wondering if that qualified as a valid Markdown linter to have in place and if so whether it could be added.

@henryiii henryiii transferred this issue from scientific-python/repo-review Nov 20, 2024
@henryiii
Copy link
Collaborator

Sure, I think it would be fine if you want it in the list. Though I think that's a linter, rather than a formatter, but if someone has that, it's probably not helpful to ask them to add a formatter too?

@ns-rse
Copy link
Author

ns-rse commented Nov 22, 2024

It will automatically reformat some errors it finds if the configured with fix: true but like black and ruff it doesn't fix everything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants