Skip to content

docs: fix missing backtick in Windows setup commands #4559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 14, 2025
Merged

docs: fix missing backtick in Windows setup commands #4559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/guides/local-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ npx husky install
# Add commit message linting to commit-msg hook
echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "npx --no -- commitlint --edit `$1" > .husky/commit-msg
echo "npx --no -- commitlint --edit `$1`" > .husky/commit-msg
```

As an alternative you can create a script inside `package.json`
Expand All @@ -62,7 +62,7 @@ yarn husky install
# Add commit message linting to commit-msg hook
echo "yarn commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "yarn commitlint --edit `$1" > .husky/commit-msg
echo "yarn commitlint --edit `$1`" > .husky/commit-msg
```

As an alternative you can create a script inside `package.json`
Expand All @@ -88,7 +88,7 @@ pnpm husky install
# Add commit message linting to commit-msg hook
echo "pnpm dlx commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "pnpm dlx commitlint --edit `$1" > .husky/commit-msg
echo "pnpm dlx commitlint --edit `$1`" > .husky/commit-msg
```

As an alternative you can create a script inside `package.json`
Expand All @@ -111,7 +111,7 @@ bunx husky install
# Add commit message linting to commit-msg hook
echo "bunx commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "bunx commitlint --edit `$1" > .husky/commit-msg
echo "bunx commitlint --edit `$1`" > .husky/commit-msg
```

== deno
Expand All @@ -127,7 +127,7 @@ deno task --eval husky install
# Add commit message linting to commit-msg hook
echo "deno task --eval commitlint --edit \$1" > .husky/commit-msg
# Windows users should use ` to escape dollar signs
echo "deno task --eval commitlint --edit `$1" > .husky/commit-msg
echo "deno task --eval commitlint --edit `$1`" > .husky/commit-msg
```

:::
Expand Down