Skip to content

fix: unify docs style and fix cross-references #27

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 3 commits into from
Jun 11, 2026
+23 −223
Merged

fix: unify docs style and fix cross-references #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06cdc92
fix: unify docs style and fix cross-references
shenxianpeng Jun 8, 2026
60c70f4
fix: revert primary color to indigo
shenxianpeng Jun 8, 2026
6cbfa74
fix: use working GitHub repo link for clang-tools-wheel
shenxianpeng Jun 11, 2026
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
9 changes: 5 additions & 4 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Select the method that best fits your development workflow:
| --- | --- |
| GitHub pull request checks | [cpp-linter-action](https://cpp-linter.github.io/cpp-linter-action/) |
| Local checks before commits | [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) |
| Custom scripts or CI jobs | [cpp-linter CLI](https://cpp-linter.github.io/cpp-linter/) |
| Custom scripts or CI jobs | [cpp-linter CLI (Python)](https://pypi.org/project/cpp-linter/) |
| High-performance local runs | [cpp-linter-rs (Rust)](https://github.com/cpp-linter/cpp-linter-rs) |


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

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

- :fontawesome-brands-python: **Command Line**
- :fontawesome-brands-python: **Command Line (Python)**

---

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

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

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

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

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

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

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

</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ title: C/C++ Linting
```yaml
repos:
- repo: https://github.com/cpp-linter/cpp-linter-hooks
rev: v1.4.0 # Use the tag or commit you want
rev: v1.5.0 # Use the tag or commit you want
hooks:
- id: clang-format
args: [--style=Google] # Other coding style: LLVM, GNU, Chromium, Microsoft, Mozilla, WebKit.
Expand Down
215 changes: 0 additions & 215 deletions docs/stylesheets/extra.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,6 @@ th {
color: black;
}

@keyframes gradientShift {
0% { background-position: 0% 50%; }
50% { background-position: 100% 50%; }
100% { background-position: 0% 50%; }
}

/* Card enhancements */
.md-typeset .grid.cards > .card-content {
background: var(--md-default-bg-color);
Expand Down Expand Up @@ -168,32 +162,6 @@ th {
color: var(--md-default-fg-color--light);
}

.stats-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(150px, 1fr));
gap: 2rem;
padding: 0 2rem;
}

.stat {
text-align: center;
}

.stat strong {
display: block;
font-size: 2rem;
font-weight: 700;
color: var(--md-primary-fg-color);
margin-bottom: 0.5rem;
}

.stat span {
font-size: 0.9rem;
color: var(--md-default-fg-color--light);
text-transform: uppercase;
letter-spacing: 0.5px;
}

/* Mobile responsiveness for trusted by section */
@media screen and (max-width: 768px) {
.logo-grid {
Expand All @@ -202,14 +170,7 @@ th {
padding: 0 1rem;
}

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

.stat strong {
font-size: 1.5rem;
}
}

/* Ensure tab items have proper contrast */
Expand Down Expand Up @@ -249,164 +210,6 @@ th {
background-color: #00b8d41a;
}

@keyframes heart {

0%,
40%,
80%,
to {
transform: scale(1)
}

20%,
60% {
transform: scale(1.15)
}
}

.md-typeset .mdx-heart {
animation: heart 1s infinite
}

.md-typeset .mdx-badge {
font-size: .85em
}

.md-typeset .mdx-badge--heart {
color: #ff4281;
}

.md-typeset .mdx-badge--heart.twemoji {
animation: heart 1s infinite
}

.md-typeset .mdx-badge--right {
float: right;
margin-left: .35em
}

[dir=ltr] .md-typeset .mdx-badge__icon {
border-top-left-radius: .1rem
}

[dir=rtl] .md-typeset .mdx-badge__icon {
border-top-right-radius: .1rem
}

[dir=ltr] .md-typeset .mdx-badge__icon {
border-bottom-left-radius: .1rem
}

[dir=rtl] .md-typeset .mdx-badge__icon {
border-bottom-right-radius: .1rem
}

.md-typeset .mdx-badge__icon {
background: var(--md-accent-fg-color--transparent);
padding: .2rem
}

.md-typeset .mdx-badge__icon:last-child {
border-radius: .1rem
}

[dir=ltr] .md-typeset .mdx-badge__text {
border-top-right-radius: .1rem
}

[dir=rtl] .md-typeset .mdx-badge__text {
border-top-left-radius: .1rem
}

[dir=ltr] .md-typeset .mdx-badge__text {
border-bottom-right-radius: .1rem
}

[dir=rtl] .md-typeset .mdx-badge__text {
border-bottom-left-radius: .1rem
}

.md-typeset .mdx-badge__text {
box-shadow: 0 0 0 1px inset var(--md-accent-fg-color--transparent);
padding: .2rem .3rem
}

.md-typeset .mdx-social {
height: min(27rem, 80vw);
position: relative
}

.md-typeset .mdx-social:hover .mdx-social__image {
background-color: #e4e4e40d
}

.md-typeset .mdx-social__layer {
margin-top: 4rem;
position: absolute;
transform-style: preserve-3d;
transition: .25s cubic-bezier(.7, 0, .3, 1)
}

.md-typeset .mdx-social__layer:hover .mdx-social__label {
opacity: 1
}

.md-typeset .mdx-social__layer:hover .mdx-social__image {
background-color: #7f7f7ffc
}

.md-typeset .mdx-social__layer:hover~.mdx-social__layer {
opacity: 0
}

.md-typeset .mdx-social__image {
box-shadow: -.25rem .25rem .5rem #0000000d;
transform: rotate(-40deg) skew(15deg, 15deg) scale(.7);
transition: all .25s
}

.md-typeset .mdx-social__image img {
display: block
}

.md-typeset .mdx-social__label {
background-color: var(--md-default-fg-color--light);
color: var(--md-default-bg-color);
display: block;
opacity: 0;
padding: .2rem .4rem;
position: absolute;
transition: all .25s
}

.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(6) {
transform: translateY(-30px)
}

.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(5) {
transform: translateY(-20px)
}

.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(4) {
transform: translateY(-10px)
}

.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(3) {
transform: translateY(0)
}

.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(2) {
transform: translateY(10px)
}

.md-typeset .mdx-social:hover .mdx-social__layer:first-child {
transform: translateY(20px)
}

.md-typeset .mdx-social:hover .mdx-social__layer:nth-child(0) {
transform: translateY(30px)
}

.md-banner {
color: var(--md-footer-fg-color--lighter)
}
Expand Down Expand Up @@ -447,24 +250,6 @@ th {
max-height: none
}

/* annotation buttons' pulse animation */
a.md-annotation__index {
border-radius: 2.2ch;
}

@keyframes pulse {
0% {
box-shadow: 0 0 0 0 var(--md-accent-fg-color);
transform: scale(.95)
}

75% {
box-shadow: 0 0 0 .625em transparent;
transform: scale(1)
}

to {
box-shadow: 0 0 0 0 transparent;
transform: scale(.95)
}
}
20 changes: 17 additions & 3 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,23 @@ theme:
features:
- navigation.tabs
- navigation.tabs.sticky
- toc.integrate
- navigation.top
- navigation.sections
- navigation.footer
- content.code.annotate
- content.code.copy
- content.tabs.link
- search.suggest
- search.share
- toc.follow
logo: static/logo.png
favicon: static/favicon.ico
icon:
repo: fontawesome/brands/github
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: blue
primary: indigo
accent: cyan
toggle:
icon: material/brightness-auto
Expand All @@ -56,14 +62,22 @@ theme:


markdown_extensions:
- pymdownx.superfences
- admonition
- attr_list
- md_in_html
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
linenums_style: pymdownx-inline
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
- toc:
permalink: true

plugins:
- search
Expand Down