eslint-markdown

Appearance

Contributing ​

This repository uses npm workspaces to maintain a monorepo.

Directory Structure ​

All packages are located in the packages directory, and the documentation can be found in the website directory.

Installation ​

  1. Fork it.

  2. Clone it to your local directory. (Git is required.)

    sh
    git clone https://github.com/eslint-markdown/eslint-markdown.git

  3. Move to the eslint-markdown directory.

    sh
    cd eslint-markdown

  4. Install npm packages. (Node.js is required.)

    sh
    npm install

  5. Edit codes.

  6. Create my-branch branch.

    sh
    git switch -c my-branch

  7. Commit your changes. (husky and lint-staged will lint your changed files!)

    sh
    git commit -am "<type>[scope]: <description>"

  8. Push them to your remote branch.

  9. Submit a pull request.🙇‍♂️

Helpful Websites ​