cpp-linter.github.io

Documentation website for the cpp-linter project and organization.

This repository hosts the public site at https://cpp-linter.github.io/, including the homepage, getting started guides, and community links for the C/C++ linting ecosystem around cpp-linter.

Website

• Main site: https://cpp-linter.github.io/
• GitHub organization: https://github.com/cpp-linter

What You'll Find

• Project overview and landing page content
• Getting started documentation
• "Why cpp-linter?": how the toolchain compares with other clang-format / clang-tidy actions and hooks
• Showcase of open-source projects that use cpp-linter
• Blog posts and guides
• Links to the clang tools packages (pip, Homebrew, asdf, static binaries, Docker images, wheels)
• Community entry points and the sponsor page

Build

pipx run nox -s docs       # build into site/
pipx run nox -s docs-live  # preview with live reload

Files other projects use

Other repositories load these files from the published site, so do not rename or remove them without updating those repositories:

• docs/stylesheets/shared.css, served at https://cpp-linter.github.io/stylesheets/shared.css, is loaded by the docs sites of cpp-linter-action, cpp-linter, clang-tools-pip and cpp-linter-rs. It carries the site's look (colors, header, fonts), so a change to it changes all of them.
• docs/fonts/, served at https://cpp-linter.github.io/fonts/, holds the fonts that shared.css declares (SIL Open Font License 1.1). Keep the file names in sync with it.
• docs/install-wheel.sh, served at https://cpp-linter.github.io/install-wheel.sh, is used by the clang-tools-wheel README and its release workflow.