Skip to content

docs: add the npm packages to Get started and the home page #88

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
shenxianpeng merged 1 commit into from
Oct 22, 2026
Merged

docs: add the npm packages to Get started and the home page #88

Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,15 @@ is in release candidates. Use the Python package until 2.0 is released.
## Just the clang tools

These install `clang-format`, `clang-tidy` and other LLVM tools without building LLVM. clang-tools,
asdf and the Homebrew tap use the same
the npm packages, asdf and the Homebrew tap use the same
[static binaries](https://cpp-linter.github.io/clang-tools-static-binaries/). Their
download page links every file, shows which versions LLVM, PyPI, conda-forge and Homebrew
have, and explains how to check a download.

| Package | LLVM | Runs on | Install |
| --- | --- | --- | --- |
| [clang-tools](https://cpp-linter.github.io/clang-tools-pip/) | 12 to 23 | Linux, macOS, Windows | `pip install clang-tools`, then `clang-tools install clang-format clang-tidy --version 21` |
| [npm packages](https://github.com/cpp-linter/clang-tools-npm) | 12 to 23 | Linux, macOS, Windows on x86-64 and ARM64 | `npm install --save-dev @cpp-linter/clang-format@21 @cpp-linter/clang-tidy@21`, then `npx clang-tidy` |
| [asdf plugin](https://github.com/cpp-linter/asdf-clang-tools) | 12 to 23 | wherever asdf runs | `asdf plugin add clang-format https://github.com/cpp-linter/asdf-clang-tools.git` |
| [Homebrew tap](https://github.com/cpp-linter/homebrew-tap) | 19 to 23 | macOS only | `brew install cpp-linter/tap/clang-format@21` |
| [Static binaries](https://cpp-linter.github.io/clang-tools-static-binaries/) | 12 to 23 | Linux, macOS, Windows on x86-64 and ARM64 | download one file from the download page |
Expand Down
3 changes: 2 additions & 1 deletion docs/overrides/home.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ <h1 class="cl-hero__title">
},
{
"title": "Just the clang tools", "name": "clang-tools", "icon": "octicons/package-24",
"text": "clang-format, clang-tidy and friends for LLVM 12 to 23 via pip or asdf, plus Docker images (up to 22) and a macOS Homebrew tap (19 to 23).",
"text": "clang-format, clang-tidy and friends for LLVM 12 to 23 via pip, npm or asdf, plus Docker images (up to 22) and a macOS Homebrew tap (19 to 23).",
"code": "pip install clang-tools\nclang-tools install clang-format clang-tidy --version 21",
"href": "https://cpp-linter.github.io/clang-tools-pip/", "cta": "Read the docs",
},
Expand Down Expand Up @@ -454,6 +454,7 @@ <h2>Maintained by two volunteers</h2>
<a href="https://cpp-linter.github.io/cpp-linter/">Python CLI</a>
<a href="https://cpp-linter.github.io/clang-tools-pip/">clang-tools</a>
<a href="https://cpp-linter.github.io/clang-tools-static-binaries/">Static binaries</a>
<a href="https://github.com/cpp-linter/clang-tools-npm">npm packages</a>
<a href="https://hub.docker.com/r/xianpengshen/clang-tools">Docker images</a>
</nav>
<nav aria-label="Learn">
Expand Down
Loading