@@ -293,48 +293,41 @@ NodeJS.
293293Remark-CLI can be installed via [ npm] ( https://www.npmjs.com/ ) , which is part of
294294the NodeJS distribution.
295295
296- To install the packages we use for our style guide, the following command will
297- work on most command lines:
296+ To install the packages we use for our style guide, use the following command:
298297
299298``` shell
300- npm install ` cat npm-requirements.txt`
301- ```
302-
303- The equivalent command on PowerShell is:
304-
305- ``` shell
306- npm install @ (cat npm-requirements.txt)
299+ npm install
307300```
308301
309302### 3. Find documents that are failing the check
310303
311304Run the following from the root directory of ` bids-specification ` :
312305
313306``` shell
314- npx remark ./src/ * .md ./src/ * / * .md
307+ npm run remark
315308```
316309
317310### 4. Fix the flagged document
318311
319312Please go to the directory where the flagged file is and run remark like this:
320313
321314``` shell
322- npx remark flagged_file.md -o flagged_file_fixed.md
315+ npx remark path/to/ flagged_file.md -o path/to/ flagged_file_fixed.md
323316```
324317
325- Please confirm this has fixed the file. To do this, please run this :
318+ To confirm this has fixed the file, run:
326319
327320``` shell
328- npx remark flagged_file_fixed.md --frail
321+ npx remark path/to/ flagged_file_fixed.md --frail
329322```
330323
331324This command will indicate whether this file now conforms to the style guide.
332325If it passes, replace ` flagged_file.md ` with the contents of
333326` flagged_file_fixed.md ` , add and commit the change:
334327
335328``` shell
336- mv flagged_file_fixed.md flagged_file.md
337- git add flagged_file.md
329+ mv path/to/ flagged_file_fixed.md path/to/ flagged_file.md
330+ git add path/to/ flagged_file.md
338331git commit -m ' STY: Fixed Markdown style'
339332```
340333
0 commit comments