Skip to content

Commit d7c886b

Browse files
Remove Vale extention instructions to run Vale in locally
1 parent 13241e6 commit d7c886b

File tree

1 file changed

+0
-31
lines changed

1 file changed

+0
-31
lines changed

README.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -151,37 +151,6 @@ To install markdownlint on Visual Studio Code (VSCode),
151151
3. Reload the extension to load the rules.
152152
4. Fix all markdownlint errors underlined in yellow.
153153

154-
### Vale
155-
156-
[Vale](https://github.com/errata-ai/vale) offers a fast, open-source solution for linting prose, ensuring consistency, clarity, and quality in documentation.
157-
158-
The current setup uses well-established industry rule sets such as [Microsoft](https://github.com/errata-ai/Microsoft) and [write-good](https://github.com/errata-ai/write-good), which provide guidelines for grammar, tone, and readability. We're working on adding custom rules to align with evolving style and voice requirements.
159-
160-
To install Vale in Visual Studio Code (VSCode),
161-
162-
1. Install the **Vale VSCode** extension.
163-
164-
2. In the extension's settings page, provide the absolute path of the `vale.ini` configuration file as the `config`.
165-
166-
The configuration file and rule sets live in the following locations of the repository:
167-
168-
```text
169-
.
170-
├── vale.ini #Main configuration file for Vale at the root
171-
└── .vale/
172-
└── styles/ #Contains style guides
173-
├── Microsoft/
174-
└── write-good/
175-
176-
```
177-
<!-- vale off -->
178-
3. On the same settings page, select the **Install Vale** checkbox. When you enable the extension, this option attempts to install Vale on your system. If the installation fails, manually install Vale by following the instructions in the [Vale documentation](https://vale.sh/docs/install) and ensure that Vale is added to your system's PATH.
179-
<!-- vale on -->
180-
181-
4. Enable the extension for syntax highlighting.
182-
183-
5. Vale provides three different highlights; `errors` (red), `warnings`(yellow) and `info` (blue). Remove errors and warnings. Optionally, improve info messages as needed.
184-
185154
## Contribute to documentation
186155

187156
Before you contribute, read the following guidelines to understand how you can start contributing:

0 commit comments

Comments
 (0)