Skip to content

Commit

Permalink
Fix: Improve Markdownlint installation instructions
Browse files Browse the repository at this point in the history
Clarified the installation process for Markdownlint, making it easier to follow and addressing potential issues with `nvm` and `zsh`.
  • Loading branch information
RedAtman committed Aug 6, 2024
1 parent 3681a1c commit 9090184
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,14 +142,15 @@ 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:
* 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
`.zshenv` and not `.zshrc`.
4. If you are using `zsh` and `oh-my-zsh`, do not load the `nvm` plug-in for
`oh-my-zsh`.

* 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
`.zshenv` and not `.zshrc`.
4. If you are using `zsh` and `oh-my-zsh`, do not load the `nvm` plug-in for
`oh-my-zsh`.

**Markdownlint Configuration Files**

Expand Down

0 comments on commit 9090184

Please sign in to comment.