From 3681a1c1aefe9f20ef50fcfff01718e97a95e930 Mon Sep 17 00:00:00 2001 From: redatman Date: Tue, 6 Aug 2024 20:44:17 +0800 Subject: [PATCH 1/2] Fix: Improve installation instructions for markdownlint Clarify the installation instructions for `markdownlint`, providing a clearer step-by-step process for users. This ensures a smoother setup experience for users. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8ce373a..12ad391 100644 --- a/README.md +++ b/README.md @@ -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 From 9090184dd8fab5c9359761f85ef6386862a2a71c Mon Sep 17 00:00:00 2001 From: redatman Date: Tue, 6 Aug 2024 20:45:38 +0800 Subject: [PATCH 2/2] Fix: Improve Markdownlint installation instructions Clarified the installation process for Markdownlint, making it easier to follow and addressing potential issues with `nvm` and `zsh`. --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 12ad391..ac187d8 100644 --- a/README.md +++ b/README.md @@ -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**