Skip to content

Commit 7f03a5d

Browse files
Hermione2408actions-user
authored andcommitted
feat: add instructions to run vale locally in README
Signed-off-by: Hermione Dadheech <[email protected]>
1 parent 93f6db0 commit 7f03a5d

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,60 @@ npm start
7575

7676
The command starts a local development server and opens a browser window.
7777

78+
## Running Vale Locally for Documentation Linting
79+
80+
To help maintain consistency in our documentation, we use Vale, a syntax-aware linter that checks for spelling, grammar, and style issues.
81+
82+
### Installation
83+
84+
**Step 1: Install Vale**
85+
86+
If you're on macOS, you can install Vale using Homebrew:
87+
88+
```bash
89+
brew install vale
90+
```
91+
92+
Alternatively, you can install Vale manually:
93+
94+
1. Download Vale: Visit the Vale Releases page and download the latest version for your operating system.
95+
96+
2. Install Vale:
97+
98+
- On macOS and Linux, extract the binary, move it to /usr/local/bin, and make it executable:
99+
100+
```bash
101+
sudo mv vale /usr/local/bin/
102+
sudo chmod +x /usr/local/bin/vale
103+
```
104+
105+
- On Windows, follow the instructions in the downloaded .zip file.
106+
107+
**Step 2: Configure Vale**
108+
109+
1. Ensure you have the .vale.ini configuration file in the root directory.
110+
111+
2. Check that StylesPath in .vale.ini points to the vale_styles directory (where custom styles are stored):
112+
113+
```ini
114+
StylesPath = vale_styles
115+
MinAlertLevel = error
116+
```
117+
118+
### Running Vale
119+
120+
1. Linting Documentation: To check all markdown files in versioned_docs/version-2.0.0/ for errors, run:
121+
122+
```bash
123+
vale versioned_docs/version-2.0.0/**/*.md
124+
```
125+
126+
2. Review Errors:
127+
128+
- Vale will output any issues directly in the terminal. Address these issues in the markdown files to maintain style consistency.
129+
130+
Note: Running Vale locally helps catch issues early, ensuring a smooth review process when you submit a pull request.
131+
78132
## Prettier
79133

80134
1. Fork the repository

0 commit comments

Comments
 (0)