Skip to content

Commit 594cb80

Browse files
committed
Update documentation guidelines to reflect markdownlint-cli2 instead of markdownlint
1 parent b333f23 commit 594cb80

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/en/contributing/documentation.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -453,16 +453,16 @@ You can use `npx` to run the tools without installing them globally, or install
453453
```bash [Using npx (Recommended)]
454454
# No installation needed - npx downloads and runs the tools
455455
npx cspell --config .github/cspell.json "docs/en/**/*.md"
456-
npx markdownlint-cli --config .github/markdownlint.json "docs/en/**/*.md"
456+
npx markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc "docs/en/**/*.md"
457457
```
458458

459459
```bash [Global Installation]
460460
# Install globally for faster execution
461-
npm install -g cspell markdownlint-cli
461+
npm install -g cspell markdownlint-cli2
462462

463463
# Then run without npx
464464
cspell --config .github/cspell.json "docs/en/**/*.md"
465-
markdownlint-cli --config .github/markdownlint.json "docs/en/**/*.md"
465+
markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc "docs/en/**/*.md"
466466
```
467467

468468
:::
@@ -496,28 +496,30 @@ If cspell flags legitimate technical terms (class names, CakePHP-specific terms)
496496

497497
### Running Markdown Lint
498498

499-
We use [markdownlint](https://github.com/DavidAnson/markdownlint) to maintain consistent markdown formatting:
499+
We use [markdownlint](https://github.com/DavidAnson/markdownlint) via
500+
[markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to maintain
501+
consistent markdown formatting:
500502

501503
::: code-group
502504

503505
```bash [Single File]
504506
# Check a single file
505-
npx markdownlint-cli --config .github/markdownlint.json docs/en/your-file.md
507+
npx markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc docs/en/your-file.md
506508
```
507509

508510
```bash [Directory]
509511
# Check all files in a directory
510-
npx markdownlint-cli --config .github/markdownlint.json "docs/en/controllers/*.md"
512+
npx markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc "docs/en/controllers/*.md"
511513
```
512514

513515
```bash [All Docs]
514516
# Check all English documentation
515-
npx markdownlint-cli --config .github/markdownlint.json "docs/en/**/*.md"
517+
npx markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc "docs/en/**/*.md"
516518
```
517519

518520
```bash [Auto-fix]
519521
# Automatically fix formatting issues
520-
npx markdownlint-cli --config .github/markdownlint.json --fix "docs/en/**/*.md"
522+
npx markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc --fix "docs/en/**/*.md"
521523
```
522524

523525
:::
@@ -583,14 +585,14 @@ When you submit a pull request, our CI pipeline automatically runs:
583585

584586
```bash [Quick Check]
585587
# Validate markdown and spelling
586-
npx markdownlint-cli --config .github/markdownlint.json "docs/**/*.md"
588+
npx markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc "docs/**/*.md"
587589
npx cspell --config .github/cspell.json "docs/**/*.md"
588590
node bin/check-links.js "docs/**/*.md"
589591
```
590592

591593
```bash [Full Validation]
592594
# Run all CI checks locally
593-
npx markdownlint-cli --config .github/markdownlint.json "docs/**/*.md"
595+
npx markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc "docs/**/*.md"
594596
npx cspell --config .github/cspell.json "docs/**/*.md"
595597
node bin/check-links.js "docs/**/*.md"
596598
node --check config.js
@@ -599,7 +601,7 @@ jq empty toc_en.json
599601

600602
```bash [Single File]
601603
# Check your current file before committing
602-
npx markdownlint-cli --config .github/markdownlint.json docs/en/your-file.md
604+
npx markdownlint-cli2 --config .github/.markdownlint-cli2.jsonc docs/en/your-file.md
603605
npx cspell --config .github/cspell.json docs/en/your-file.md
604606
node bin/check-links.js docs/en/your-file.md
605607
```

0 commit comments

Comments
 (0)