Markdown Lint

[JakobMiksch]

This PR superseeds #76
It adds another hook to pre-commit that lints the Markdown using markdownlint-cli2.
This enforces a common Markdown style defined in .markdownlint.json

[pblottiere]

Nice thanks @JakobMiksch 👍.

My only concern is about homogeneity. For example in some console code blocks, the leading $ is kept while it has been removed in others. For example:

VS

Do you have any idea?

[JakobMiksch]

I updated the PR to the latest changes on main.

My only concern is about homogeneity. For example in some console code blocks, the leading $ is kept while it has been removed in others. For example:

The first examples contains some lines that don't start with $, I guess that's why they are not linted.

Here is the rule regarding the $ sign: https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md014.md
It links to this styleguide: https://cirosantilli.com/markdown-style-guide/#dollar-signs-in-shell-code

It essentially recommends that when you use $ you should have the CLI output in the next line(s).

My preference would be to remove $ completely, but I do not have a strong opinion as long it is consistent.

What do you prefer, is removing $ okay for you?

[pblottiere]

What do you prefer, is removing $ okay for you?

Yes +1 for following the styleguide https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md014.md 👍

Thanks!

[JakobMiksch]

@pblottiere I removed the $ where applicable, but left in a few places where actually makes sense