Skip to content

Commit cadd021

Browse files
committed
fix: unify docs style and fix cross-references
- Change primary palette from 'indigo' to 'blue' to match cpp-linter-action - Add missing MkDocs features: navigation.footer, content.code.copy, content.code.annotate, search.suggest, search.share, toc.follow, content.tabs.link - Add missing markdown extensions: admonition, pymdownx.highlight, pymdownx.inlinehilite, pymdownx.snippets, toc (with permalink) - Remove toc.integrate (incompatible with toc.follow) - Fix broken links: cpp-linter CLI and cpp-linter-rs now point to real destinations (PyPI and GitHub) instead of non-existent cpp-linter.github.io sub-sites - Add cpp-linter-rs to the quick-reference table - Update pre-commit hooks version from v1.4.0 to v1.5.0 - Fix clang-tools-wheel link to point to GitHub Pages instead of GitHub - Remove unused CSS: heart animation, badge styles, social layer styles, pulse animation, stats-grid (not used by hub site)
1 parent 02a594f commit cadd021

4 files changed

Lines changed: 25 additions & 225 deletions

File tree

docs/getting-started.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Select the method that best fits your development workflow:
2020
| --- | --- |
2121
| GitHub pull request checks | [cpp-linter-action](https://cpp-linter.github.io/cpp-linter-action/) |
2222
| Local checks before commits | [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) |
23-
| Custom scripts or CI jobs | [cpp-linter CLI](https://cpp-linter.github.io/cpp-linter/) |
23+
| Custom scripts or CI jobs | [cpp-linter CLI (Python)](https://pypi.org/project/cpp-linter/) |
24+
| High-performance local runs | [cpp-linter-rs (Rust)](https://github.com/cpp-linter/cpp-linter-rs) |
2425

2526

2627
<div class="grid cards" markdown>
@@ -45,15 +46,15 @@ Select the method that best fits your development workflow:
4546

4647
[Get started with pre-commit →](https://github.com/cpp-linter/cpp-linter-hooks){ .md-button .md-button--primary }
4748

48-
- :fontawesome-brands-python: **Command Line**
49+
- :fontawesome-brands-python: **Command Line (Python)**
4950

5051
---
5152

5253
Core Python package for cpp-linter-action behind the scenes
5354

5455
**Perfect for:** Local development, custom scripts, one-off analysis
5556

56-
[Get started with cpp-linter package →](https://cpp-linter.github.io/cpp-linter/){ .md-button .md-button--primary }
57+
[Get started with cpp-linter package →](https://pypi.org/project/cpp-linter/){ .md-button .md-button--primary }
5758

5859
- :simple-rust: **Command Line (Rust)**
5960

@@ -63,7 +64,7 @@ Select the method that best fits your development workflow:
6364

6465
**Perfect for:** Local development, custom scripts, one-off analysis
6566

66-
[Get started with cpp-linter-rs →](https://cpp-linter.github.io/cpp-linter-rs/){ .md-button .md-button--primary }
67+
[Get started with cpp-linter-rs →](https://github.com/cpp-linter/cpp-linter-rs){ .md-button .md-button--primary }
6768

6869
</div>
6970

@@ -93,7 +94,7 @@ Select the method that best fits your development workflow:
9394

9495
Distribution clang tools Python wheels for various platforms
9596

96-
[Download from →](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary }
97+
[Download from →](https://cpp-linter.github.io/clang-tools-wheel/){ .md-button .md-button--primary }
9798

9899
</div>
99100

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ title: C/C++ Linting
177177
```yaml
178178
repos:
179179
- repo: https://github.com/cpp-linter/cpp-linter-hooks
180-
rev: v1.4.0 # Use the tag or commit you want
180+
rev: v1.5.0 # Use the tag or commit you want
181181
hooks:
182182
- id: clang-format
183183
args: [--style=Google] # Other coding style: LLVM, GNU, Chromium, Microsoft, Mozilla, WebKit.

docs/stylesheets/extra.css

Lines changed: 0 additions & 215 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,6 @@ th {
5858
color: black;
5959
}
6060

61-
@keyframes gradientShift {
62-
0% { background-position: 0% 50%; }
63-
50% { background-position: 100% 50%; }
64-
100% { background-position: 0% 50%; }
65-
}
66-
6761
/* Card enhancements */
6862
.md-typeset .grid.cards > .card-content {
6963
background: var(--md-default-bg-color);
@@ -168,32 +162,6 @@ th {
168162
color: var(--md-default-fg-color--light);
169163
}
170164

171-
.stats-grid {
172-
display: grid;
173-
grid-template-columns: repeat(auto-fit, minmax(150px, 1fr));
174-
gap: 2rem;
175-
padding: 0 2rem;
176-
}
177-
178-
.stat {
179-
text-align: center;
180-
}
181-
182-
.stat strong {
183-
display: block;
184-
font-size: 2rem;
185-
font-weight: 700;
186-
color: var(--md-primary-fg-color);
187-
margin-bottom: 0.5rem;
188-
}
189-
190-
.stat span {
191-
font-size: 0.9rem;
192-
color: var(--md-default-fg-color--light);
193-
text-transform: uppercase;
194-
letter-spacing: 0.5px;
195-
}
196-
197165
/* Mobile responsiveness for trusted by section */
198166
@media screen and (max-width: 768px) {
199167
.logo-grid {
@@ -202,14 +170,7 @@ th {
202170
padding: 0 1rem;
203171
}
204172

205-
.stats-grid {
206-
grid-template-columns: repeat(2, 1fr);
207-
padding: 0 1rem;
208-
}
209173

210-
.stat strong {
211-
font-size: 1.5rem;
212-
}
213174
}
214175

215176
/* Ensure tab items have proper contrast */
@@ -249,164 +210,6 @@ th {
249210
background-color: #00b8d41a;
250211
}
251212

252-
@keyframes heart {
253-
254-
0%,
255-
40%,
256-
80%,
257-
to {
258-
transform: scale(1)
259-
}
260-
261-
20%,
262-
60% {
263-
transform: scale(1.15)
264-
}
265-
}
266-
267-
.md-typeset .mdx-heart {
268-
animation: heart 1s infinite
269-
}
270-
271-
.md-typeset .mdx-badge {
272-
font-size: .85em
273-
}
274-
275-
.md-typeset .mdx-badge--heart {
276-
color: #ff4281;
277-
}
278-
279-
.md-typeset .mdx-badge--heart.twemoji {
280-
animation: heart 1s infinite
281-
}
282-
283-
.md-typeset .mdx-badge--right {
284-
float: right;
285-
margin-left: .35em
286-
}
287-
288-
[dir=ltr] .md-typeset .mdx-badge__icon {
289-
border-top-left-radius: .1rem
290-
}
291-
292-
[dir=rtl] .md-typeset .mdx-badge__icon {
293-
border-top-right-radius: .1rem
294-
}
295-
296-
[dir=ltr] .md-typeset .mdx-badge__icon {
297-
border-bottom-left-radius: .1rem
298-
}
299-
300-
[dir=rtl] .md-typeset .mdx-badge__icon {
301-
border-bottom-right-radius: .1rem
302-
}
303-
304-
.md-typeset .mdx-badge__icon {
305-
background: var(--md-accent-fg-color--transparent);
306-
padding: .2rem
307-
}
308-
309-
.md-typeset .mdx-badge__icon:last-child {
310-
border-radius: .1rem
311-
}
312-
313-
[dir=ltr] .md-typeset .mdx-badge__text {
314-
border-top-right-radius: .1rem
315-
}
316-
317-
[dir=rtl] .md-typeset .mdx-badge__text {
318-
border-top-left-radius: .1rem
319-
}
320-
321-
[dir=ltr] .md-typeset .mdx-badge__text {
322-
border-bottom-right-radius: .1rem
323-
}
324-
325-
[dir=rtl] .md-typeset .mdx-badge__text {
326-
border-bottom-left-radius: .1rem
327-
}
328-
329-
.md-typeset .mdx-badge__text {
330-
box-shadow: 0 0 0 1px inset var(--md-accent-fg-color--transparent);
331-
padding: .2rem .3rem
332-
}
333-
334-
.md-typeset .mdx-social {
335-
height: min(27rem, 80vw);
336-
position: relative
337-
}
338-
339-
.md-typeset .mdx-social:hover .mdx-social__image {
340-
background-color: #e4e4e40d
341-
}
342-
343-
.md-typeset .mdx-social__layer {
344-
margin-top: 4rem;
345-
position: absolute;
346-
transform-style: preserve-3d;
347-
transition: .25s cubic-bezier(.7, 0, .3, 1)
348-
}
349-
350-
.md-typeset .mdx-social__layer:hover .mdx-social__label {
351-
opacity: 1
352-
}
353-
354-
.md-typeset .mdx-social__layer:hover .mdx-social__image {
355-
background-color: #7f7f7ffc
356-
}
357-
358-
.md-typeset .mdx-social__layer:hover~.mdx-social__layer {
359-
opacity: 0
360-
}
361-
362-
.md-typeset .mdx-social__image {
363-
box-shadow: -.25rem .25rem .5rem #0000000d;
364-
transform: rotate(-40deg) skew(15deg, 15deg) scale(.7);
365-
transition: all .25s
366-
}
367-
368-
.md-typeset .mdx-social__image img {
369-
display: block
370-
}
371-
372-
.md-typeset .mdx-social__label {
373-
background-color: var(--md-default-fg-color--light);
374-
color: var(--md-default-bg-color);
375-
display: block;
376-
opacity: 0;
377-
padding: .2rem .4rem;
378-
position: absolute;
379-
transition: all .25s
380-
}
381-
382-
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(6) {
383-
transform: translateY(-30px)
384-
}
385-
386-
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(5) {
387-
transform: translateY(-20px)
388-
}
389-
390-
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(4) {
391-
transform: translateY(-10px)
392-
}
393-
394-
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(3) {
395-
transform: translateY(0)
396-
}
397-
398-
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(2) {
399-
transform: translateY(10px)
400-
}
401-
402-
.md-typeset .mdx-social:hover .mdx-social__layer:first-child {
403-
transform: translateY(20px)
404-
}
405-
406-
.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(0) {
407-
transform: translateY(30px)
408-
}
409-
410213
.md-banner {
411214
color: var(--md-footer-fg-color--lighter)
412215
}
@@ -447,24 +250,6 @@ th {
447250
max-height: none
448251
}
449252

450-
/* annotation buttons' pulse animation */
451253
a.md-annotation__index {
452254
border-radius: 2.2ch;
453255
}
454-
455-
@keyframes pulse {
456-
0% {
457-
box-shadow: 0 0 0 0 var(--md-accent-fg-color);
458-
transform: scale(.95)
459-
}
460-
461-
75% {
462-
box-shadow: 0 0 0 .625em transparent;
463-
transform: scale(1)
464-
}
465-
466-
to {
467-
box-shadow: 0 0 0 0 transparent;
468-
transform: scale(.95)
469-
}
470-
}

mkdocs.yml

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,15 @@ theme:
2020
features:
2121
- navigation.tabs
2222
- navigation.tabs.sticky
23-
- toc.integrate
2423
- navigation.top
2524
- navigation.sections
25+
- navigation.footer
26+
- content.code.annotate
27+
- content.code.copy
28+
- content.tabs.link
29+
- search.suggest
30+
- search.share
31+
- toc.follow
2632
logo: static/logo.png
2733
favicon: static/favicon.ico
2834
icon:
@@ -39,7 +45,7 @@ theme:
3945
# Palette toggle for light mode
4046
- media: "(prefers-color-scheme: light)"
4147
scheme: default
42-
primary: indigo
48+
primary: blue
4349
accent: cyan
4450
toggle:
4551
icon: material/lightbulb-outline
@@ -48,22 +54,30 @@ theme:
4854
# Palette toggle for dark mode
4955
- media: "(prefers-color-scheme: dark)"
5056
scheme: slate
51-
primary: indigo
57+
primary: blue
5258
accent: cyan
5359
toggle:
5460
icon: material/lightbulb
5561
name: Switch to system preference
5662

5763

5864
markdown_extensions:
59-
- pymdownx.superfences
65+
- admonition
6066
- attr_list
6167
- md_in_html
68+
- pymdownx.superfences
6269
- pymdownx.tabbed:
6370
alternate_style: true
6471
- pymdownx.emoji:
6572
emoji_index: !!python/name:material.extensions.emoji.twemoji
6673
emoji_generator: !!python/name:material.extensions.emoji.to_svg
74+
- pymdownx.highlight:
75+
linenums_style: pymdownx-inline
76+
- pymdownx.inlinehilite
77+
- pymdownx.snippets:
78+
check_paths: true
79+
- toc:
80+
permalink: true
6781

6882
plugins:
6983
- search

0 commit comments

Comments
 (0)