docusaurus icon indicating copy to clipboard operation
docusaurus copied to clipboard

We need a markdown linting tools for developers.

Open lijiarui opened this issue 3 years ago • 6 comments

Juzibot have a markdown tool for non-developers to write markdown: https://meeken1998.github.io/chinese-document.html

I think we need a markdown tool as well for our community.

lijiarui avatar Nov 08 '21 10:11 lijiarui

I will try when im free (maybe

Meeken1998 avatar Nov 08 '21 10:11 Meeken1998

typora is very beautifual..... but building rules is very strict...

livingbody avatar Nov 08 '21 10:11 livingbody

We have a vert simple solution that works out-of-the-box:

  1. use vscode to open our wechaty.js.org repo
  2. install the markdownlint vscode extension (it will use this config file automatically)
  3. install the editorconfig vscode extension (it will use this config file automatically)
  4. You are set. VSCode will tell you everything

@livingbody @Meeken1998

huan avatar Nov 08 '21 10:11 huan

@huan You are right, but not all contributors have vscode, such as: https://github.com/wechaty/wechaty.js.org/pull/1115

lijiarui avatar Nov 08 '21 11:11 lijiarui

2. markdownlint

what a good man you are! +999

livingbody avatar Nov 08 '21 11:11 livingbody

@livingbody You are welcome.

@lijiarui VSCode is not a big deal, today, it's just a web page.

huan avatar Nov 08 '21 11:11 huan