Skip to content

Commit

Permalink
Fix: Improve installation instructions for markdownlint
Browse files Browse the repository at this point in the history
Clarify the installation instructions for `markdownlint`, providing a clearer step-by-step process for users. This ensures a smoother setup experience for users.
  • Loading branch information
RedAtman committed Aug 6, 2024
1 parent 081b896 commit 3681a1c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,10 @@ If your note begins with "#", it will automatically be marked as Markdown format
### Automatically formatting

> Default auto enable Markdown auto formatting. You can disable it in the settings file: `markdown: {"formatting": false}`
> Before using this plug-in, you must ensure that [markdownlint][CLI] is installed on your system. To install `markdownlint`, do the following:
> If you use HomeBrew: `brew install markdownlint-cli`
> Other method:
Before using this plug-in, you must ensure that [markdownlint][CLI] is installed on your system. To install `markdownlint`, do the following:
* If you use HomeBrew: `brew install markdownlint-cli`
* Other method:
1. Install [Node.js](http://nodejs.org).
2. Install `markdownlint` by typing the following in a terminal: `npm install -g markdownlint-cli`
3. If you are using `nvm` and `zsh`, ensure that the line to load `nvm` is in
Expand Down

0 comments on commit 3681a1c

Please sign in to comment.