Skip to content

Commit 632877e

Browse files
committed
docs: match the home page to what the tools do, and unify site colors
The review and summary comment mockups now show github-actions as the author, with the wording cpp-linter actually posts. There is no cpp-linter bot account; comments come from the workflow token or your own App. Copy that read opt-in features as defaults now names the input and the permission it needs: review suggestions, the summary comment and auto-fix. The version pin, the CLI in other CI, the clang-tools channels (Docker up to 22, a macOS Homebrew tap for 19 to 23) and the licensing are stated as they are. The quick start uses checkout@v7 and one review type, and no longer sets thread-comments, which fails on pull requests from forks. Waybar only keeps the action in a disabled .yml.bak workflow, so it is dropped from the home page and the showcase, and the star total falls to 75,000+. The other 34 showcase projects were rechecked. Inner pages now use the home page's paper background, light header and tabs, ink footer and fonts in the light scheme. Fonts load site-wide from overrides/main.html; the dark scheme keeps Material's colors.
1 parent 3a87f6d commit 632877e

7 files changed

Lines changed: 194 additions & 89 deletions

File tree

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ hide:
55
- feedback
66
template: home.html
77
title: C/C++ Linting
8-
description: clang-format and clang-tidy for C and C++ pull requests, pre-commit hooks and CI, with one LLVM version everywhere.
8+
description: clang-format and clang-tidy for C and C++ pull requests, pre-commit hooks and CI, with the LLVM version you pin.
99
---
1010

1111
<!-- The home page is built by docs/overrides/home.html. -->

‎docs/overrides/home.html‎

Lines changed: 65 additions & 64 deletions
Large diffs are not rendered by default.

‎docs/overrides/main.html‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{% extends "base.html" %}
2+
3+
{#-
4+
The site's fonts, loaded on every page: Instrument Sans for text,
5+
JetBrains Mono for code and Bricolage Grotesque for headings. theme.font is
6+
false in mkdocs.yml, so Material loads nothing itself; extra.css points
7+
Material's font variables at these.
8+
-#}
9+
10+
{% block extrahead %}
11+
{{ super() }}
12+
<link rel="preconnect" href="https://fonts.googleapis.com">
13+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
14+
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Bricolage+Grotesque:opsz,wght@12..96,500..800&family=Instrument+Sans:ital,wght@0,400..700;1,400..700&family=JetBrains+Mono:ital,wght@0,400..700;1,400..700&display=swap">
15+
{% endblock %}

‎docs/showcase.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,22 @@ description: Open-source projects that run cpp-linter-action and cpp-linter-hook
88
<!-- markdownlint-disable MD033 -->
99

1010
More than 550 public repositories run [cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action)
11-
from a workflow on their default branch, with over 87,000 GitHub stars between them.
12-
The list below is the top of that set, ranked by stars.
11+
from a workflow on their default branch, with over 75,000 GitHub stars between them.
12+
The list below is a selection from that set, ranked by stars.
1313

1414
!!! info "How this list is built"
1515
Numbers come from a GitHub code search for `cpp-linter/cpp-linter-action@` inside
1616
`.github/workflows`, restricted to non-fork, non-archived repositories, on 2026-09-12.
1717
Forks and mirrors are excluded, so the real number is higher. Star counts are from the same day.
18+
On 2026-09-24 the totals were recounted with only `.yml` and `.yaml` workflow files, so a
19+
disabled file such as `.yml.bak` does not count, and every project below was rechecked the
20+
same way.
1821

1922
## Projects
2023

2124
| Project | Stars | What it is |
2225
| --- | ---: | --- |
2326
| <img src="https://github.com/zealdocs.png?size=40" width="20" alt=""> [zealdocs/zeal](https://github.com/zealdocs/zeal) | 12,789 | Offline documentation browser |
24-
| <img src="https://github.com/Alexays.png?size=40" width="20" alt=""> [Alexays/Waybar](https://github.com/Alexays/Waybar) | 11,944 | Highly customizable Wayland bar for Sway and wlroots compositors |
2527
| <img src="https://github.com/libvips.png?size=40" width="20" alt=""> [libvips/libvips](https://github.com/libvips/libvips) | 11,633 | Fast image processing library with low memory needs |
2628
| <img src="https://github.com/diasurgical.png?size=40" width="20" alt=""> [diasurgical/DevilutionX](https://github.com/diasurgical/DevilutionX) | 9,736 | Diablo build for modern operating systems |
2729
| <img src="https://github.com/iree-org.png?size=40" width="20" alt=""> [iree-org/iree](https://github.com/iree-org/iree) | 3,925 | Retargetable MLIR-based machine learning compiler and runtime |

‎docs/stylesheets/extra.css‎

Lines changed: 85 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,93 @@
7070
box-shadow: 0 4px 12px rgba(0,0,0,0.15);
7171
}
7272

73-
/* Ensure tab items have proper contrast */
74-
.md-tabs__item {
75-
background-color: transparent;
73+
/* Fonts: loaded in overrides/main.html (theme.font is false) */
74+
:root {
75+
--md-text-font: "Instrument Sans";
76+
--md-code-font: "JetBrains Mono";
7677
}
7778

78-
.md-tabs__link {
79-
color: rgba(255, 255, 255, 0.7);
79+
.md-typeset h1,
80+
.md-typeset h2,
81+
.md-typeset h3,
82+
.md-header__topic:first-child {
83+
font-family: "Bricolage Grotesque", var(--md-text-font-family);
84+
letter-spacing: -0.01em;
8085
}
8186

82-
.md-tabs__link--active,
83-
.md-tabs__link:hover {
84-
color: white;
87+
.md-typeset h1 {
88+
color: var(--md-default-fg-color);
89+
font-weight: 760;
90+
}
91+
92+
.md-typeset h2,
93+
.md-typeset h3 {
94+
font-weight: 700;
95+
}
96+
97+
/*
98+
* Light scheme: the paper, ink and light header of the home page.
99+
* The dark scheme keeps Material's colors.
100+
*/
101+
[data-md-color-scheme="default"] {
102+
--md-default-fg-color: #171a2ede;
103+
--md-default-fg-color--light: #171a2e8f;
104+
--md-default-fg-color--lighter: #171a2e52;
105+
--md-default-fg-color--lightest: #171a2e12;
106+
--md-default-bg-color: #f7f5ef;
107+
--md-code-bg-color: #eeeae0;
108+
--md-code-bg-color--light: #eeeae0b3;
109+
--md-code-bg-color--lighter: #eeeae04d;
110+
--md-footer-bg-color: #171a2e;
111+
--md-footer-bg-color--dark: #10131f;
112+
}
113+
114+
[data-md-color-scheme="default"] .md-header,
115+
[data-md-color-scheme="default"] .md-tabs {
116+
background-color: #f7f5ef;
117+
color: #171a2e;
118+
}
119+
120+
[data-md-color-scheme="default"] .md-header {
121+
border-bottom: 1px solid #e3dfd3;
122+
}
123+
124+
[data-md-color-scheme="default"] .md-tabs__link {
125+
color: #454a63;
126+
opacity: 1;
127+
}
128+
129+
[data-md-color-scheme="default"] .md-tabs__item--active .md-tabs__link,
130+
[data-md-color-scheme="default"] .md-tabs__link:hover {
131+
color: #171a2e;
132+
}
133+
134+
[data-md-color-scheme="default"] .md-tabs__item--active .md-tabs__link {
135+
font-weight: 700;
136+
}
137+
138+
[data-md-color-scheme="default"] .md-nav--primary .md-nav__title[for="__drawer"] {
139+
background-color: #f7f5ef;
140+
color: #171a2e;
141+
}
142+
143+
[data-md-color-scheme="default"] .md-nav__source {
144+
background-color: #171a2e;
145+
}
146+
147+
@media screen and (min-width: 60em) {
148+
[data-md-color-scheme="default"] .md-search__form,
149+
[data-md-color-scheme="default"] .md-search__form:hover {
150+
background-color: #fff;
151+
border: 1px solid #d8d3c4;
152+
border-radius: 0.4rem;
153+
}
154+
155+
[data-md-color-scheme="default"] .md-search__input::placeholder {
156+
color: #62677f;
157+
}
158+
159+
[data-md-color-scheme="default"] .md-search__input + .md-search__icon {
160+
color: #454a63;
161+
}
85162
}

‎docs/stylesheets/home.css‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -784,15 +784,25 @@
784784
font-size: 14px;
785785
}
786786

787-
.cl-comment__head img,
788-
.cl-summary__head img {
787+
/* comments come from the github-actions bot (or your App), shown with a neutral avatar */
788+
.cl-avatar {
789+
display: inline-flex;
790+
flex-shrink: 0;
791+
align-items: center;
792+
justify-content: center;
789793
box-sizing: border-box;
790794
width: 26px;
791795
height: 26px;
792-
padding: 2px;
793-
background: #fff;
796+
background: #eeebe3;
794797
border: 1px solid var(--cl-line);
795798
border-radius: 999px;
799+
color: var(--cl-ink-2);
800+
}
801+
802+
.cl-avatar svg {
803+
width: 14px;
804+
height: 14px;
805+
fill: currentcolor;
796806
}
797807

798808
.cl-comment__bot {
@@ -806,15 +816,8 @@
806816
text-transform: uppercase;
807817
}
808818

809-
.cl-comment__tool {
810-
margin-left: auto;
811-
padding: 3px 8px;
812-
background: var(--cl-primary-tint);
813-
border-radius: 6px;
819+
.cl-comment__check {
814820
color: var(--cl-primary);
815-
font-family: var(--cl-mono);
816-
font-size: 11.5px;
817-
font-weight: 600;
818821
}
819822

820823
.cl-comment__body {
@@ -1007,6 +1010,7 @@
10071010
.cl-tool__code {
10081011
display: flex;
10091012
align-items: center;
1013+
white-space: pre-line;
10101014
box-sizing: border-box;
10111015
min-height: 62px;
10121016
margin-top: auto;
@@ -1220,11 +1224,15 @@
12201224
font-size: 13.5px;
12211225
}
12221226

1223-
.cl-summary__head img {
1227+
.cl-summary__head .cl-avatar {
12241228
width: 22px;
12251229
height: 22px;
12261230
}
12271231

1232+
.cl-summary__report strong {
1233+
margin-right: 4px;
1234+
}
1235+
12281236
.cl-tag {
12291237
padding: 4px 11px;
12301238
border-radius: 999px;

‎mkdocs.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ theme:
3131
- search.suggest
3232
- search.share
3333
- toc.follow
34+
# Fonts load in docs/overrides/main.html.
35+
font: false
3436
logo: static/logo.png
3537
favicon: static/favicon.ico
3638
icon:

0 commit comments

Comments
 (0)