Add markdown lint workflow

[aaron-ai]

Markdown is a lightweight markup language for creating formatted text, but there are various implementations.

To unify the specs of our docs, a markdown lint workflow is essential. An example could be referred here: https://github.com/apache/rocketmq-clients/blob/master/.github/workflows/markdown_lint.yml

[selectbook]

hi, can i hava a try?

[aaron-ai]

hi, can i hava a try?

That's great! I assigned it to you.

[sunheyi6]

Markdown is a lightweight markup language for creating formatted text, but there are various implementations.

To unify the specs of our docs, a markdown lint workflow is essential. An example could be referred here: https://github.com/apache/rocketmq-clients/blob/master/.github/workflows/markdown_lint.yml

just copy this file?

[aaron-ai]

@shy-share Hi, Thanks your attetion, the existing markdown files are also need to be fixed to pass the markdown-lint check.

[sunheyi6]

@shy-share Hi, Thanks your attetion, the existing markdown files are also need to be fixed to pass the markdown-lint check.

@aaron-ai I've learned so far that this is an npn tool that requires a style file, this should be the same as in the link, so just use npn to fix it automatically? Still don't quite understand how it's going to work.

[aaron-ai]

It seems that markdownlint could fix some basic errors, but not all. markdownlint is more concerned with style checking.

I'am not sure whether there is some errors you need to fix it manually. anyway, just fix it and pass the check.

[Abhijeetmishr]

@aaron-ai @Oliverwqcwrw can I pick this Up ?

[aaron-ai]

@Abhijeetmishr Of course, I assigned it to you.

[Abhijeetmishr]

@aaron-ai I am aware on markdown file but what exactly we have to change/update ?
Can you please explain a bit if possible ?

Regards

[Abhijeetmishr]

@aaron-ai I am aware on markdown file but what exactly we have to change/update ? Can you please explain a bit if possible ?

Regards

@aaron-ai @Oliverwqcwrw I will appreciate any help/hints.

[AayushSaini101]

Hi @aaron-ai Please assign this issue to me