search

igorshubovych / markdownlint-cli

MarkdownLint Command Line Interface
MIT License
833 stars 82 forks source link

Consider using textlint #77

Open amimas opened 4 years ago

amimas commented 4 years ago

This project has been super helpful. I have several projects for documentation written in Markdown. Using this tool helps to validate and enforce consistency in Markdown syntax.

I am also using textlint in my projects. It's a great tool for enforcing writing styile/guideline. Textlint itself is a framework that uses various rules. Quite a few rules already exist and if one doesn't exist, you can create your own rule to validate contents against your unique requirements.

You can create fixable rules so that you don't need to manually apply fixes. There's also various different ways of generating reports.

I think it'd be great if markdownlint could be used with textlint, instead of a separate cli. Textlint also offers creating "preset", which is basically a list of rules already pre-configured so that users don't need to configure those rules one at a time.

Thoughts?

DavidAnson commented 4 years ago

I wasn't aware of that project, but it looks pretty neat! Reviewing the way they handle rules briefly, it looks like it would be possible to create a rule to wrap the markdownlint CLI. Trying to wrap each rule individually does not seem as interesting, but encapsulating the whole tool like they do with Alex seems feasible. It's not something I'm likely to get done anytime soon (ever?), but it could be an interesting project for someone else.