DEV Community

Discussion on: Markdown Linting

Collapse
 
thefluxapex profile image
Ian Pride • Edited

Appreciate the post, I have seen some of this stuff before, but not used it. I will be looking at this stuff soon. To be honest, at this point in my life I only use MD for basic project READMEs and just tend to use VSCode's 'Markdown-All-In-One' extension (READMEs are the ONLY thing I use Code for...). Really that plugin by itself is good enough to install Code.

As for grammar I'm lazy and just stick what I know: apsell. I also use the 'Spell Checker' plugin for Code, but still run aspell on it just in case...

Saved this, thanks again.

Collapse
 
adamgordonbell profile image
Adam Gordon Bell

Thanks! Vale is reallly amazing in what it can do but you have to setup rules, which can be a bit of a pain. You can approach grammarly type advice for markdown.

markdownlint is amazing though. Easy to start with and pushes towards better markdown. All of this is probably overkill from readmes, but I use it on my markdown based blog and its great.

Collapse
 
thefluxapex profile image
Ian Pride

All of this is probably overkill from readmes...

-- Adam Gordon Bell [1]

Yeah, but I never know what I'll be doing and it's always nice to be familiar with options...