Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

We need a markdown linting tools for developers. #1392

Open
lijiarui opened this issue Nov 8, 2021 · 6 comments
Open

We need a markdown linting tools for developers. #1392

lijiarui opened this issue Nov 8, 2021 · 6 comments
Assignees

Comments

@lijiarui
Copy link
Member

lijiarui commented Nov 8, 2021

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.

@Meeken1998
Copy link

I will try when im free (maybe

@livingbody
Copy link
Contributor

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

@huan
Copy link
Member

huan commented Nov 8, 2021

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 huan changed the title We need a markdown link tools for developers. We need a markdown linting tools for developers. Nov 8, 2021
@lijiarui
Copy link
Member Author

lijiarui commented Nov 8, 2021

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

@livingbody
Copy link
Contributor

2. markdownlint

what a good man you are! +999

@huan
Copy link
Member

huan commented Nov 8, 2021

@livingbody You are welcome.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants