Skip to content

Commit

Permalink
docs: Clarify markdownlint installation instructions
Browse files Browse the repository at this point in the history
Updated the README to clarify instructions for installing markdownlint, making the language more concise and easier to understand.
  • Loading branch information
RedAtman committed Aug 6, 2024
1 parent c07582c commit 4378311
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,10 @@ If your note begins with "#", it will automatically be marked as Markdown format

> 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:
Before enabling this feature, 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:
* If you are use Homebrew: `brew install markdownlint-cli`.
* Other case:
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 4378311

Please sign in to comment.