Skip to content

Commit 6a13e73

Browse files
shenxianpengshenxianpeng
committed
feat: update index page and more
1 parent 1a2a5aa commit 6a13e73

File tree

4 files changed

+258
-43
lines changed

4 files changed

+258
-43
lines changed

‎docs/getting-started.md‎

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,86 @@
11
# Getting Started
22

3-
cpp-linter is an open-source organization dedicated to providing high-quality tools and solutions for C/C++ code analysis and linting. Our mission is to help developers write cleaner, more maintainable code by offering easy-to-use tools that integrate seamlessly into their development workflows.
3+
Welcome to cpp-linter! This guide will help you integrate C/C++ linting into your workflow quickly and efficiently.
44

5-
## Our Solutions
5+
## Choose Your Integration
6+
7+
Select the method that best fits your development workflow:
68

79
<div class="grid cards" markdown>
810

9-
- :fontawesome-brands-github: **cpp-linter-action**
11+
- :material-github: **GitHub Actions**
1012

1113
---
1214

1315
GitHub Action for automated C/C++ linting in your workflows
1416

15-
[Learn More](https://cpp-linter.github.io/cpp-linter-action/){ .md-button .md-button--primary }
17+
**Perfect for:** CI/CD pipelines, automated PRs, team collaboration
18+
19+
[Get started with GitHub Actions →](https://cpp-linter.github.io/cpp-linter-action/){ .md-button .md-button--primary }
20+
1621

17-
- :material-git: **cpp-linter-hooks**
22+
- :material-git: **Pre-commit Hooks**
1823

1924
---
2025

2126
Pre-commit hooks for automated C/C++ linting in your local development
2227

23-
[Learn More](https://github.com/cpp-linter/cpp-linter-hooks){ .md-button .md-button--primary }
28+
**Perfect for:** Catching issues before commits, local enforcement
2429

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

26-
- :fontawesome-brands-python: **cpp-linter**
33+
- :fontawesome-brands-python: **Command Line**
2734

2835
---
2936

30-
Core Python package for C/C++ code analysis and linting behind the scenes
37+
Core Python package for cpp-linter-action behind the scenes
3138

32-
[Learn More](https://cpp-linter.github.io/cpp-linter/){ .md-button .md-button--primary }
39+
**Perfect for:** Local development, custom scripts, one-off analysis
3340

34-
- :simple-rust: **cpp-linter-rs**
41+
[Get started with cpp-linter package →](https://cpp-linter.github.io/cpp-linter/){ .md-button .md-button--primary }
42+
43+
- :simple-rust: **Command Line (Rust)**
3544

3645
---
3746

3847
High-performance Rust implementation of cpp-linter
3948

40-
[Learn More](https://cpp-linter.github.io/cpp-linter-rs/){ .md-button .md-button--primary }
49+
**Perfect for:** Local development, custom scripts, one-off analysis
4150

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

4353
</div>
4454

4555
## Clang Tools Distribution
4656

4757
<div class="grid cards" markdown>
4858

49-
- :fontawesome-brands-python: **clang-tools-pip**
59+
- :fontawesome-brands-binary: **clang-tools-static-binaries**
5060

5161
---
5262

53-
Easy installation of clang tools static binaries via pip
63+
Distribution clang tools static binaries for various platforms
5464

55-
[Learn More](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary }
65+
[Download from →](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary }
5666

5767

5868
- :fontawesome-brands-docker: **clang-tools-docker**
5969

6070
---
6171

62-
Easy installation of clang tools via Docker images
72+
Distribution clang tools Docker images for various platforms
6373

64-
[Learn More](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary }
74+
[Download from →](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary }
6575

6676

6777
- :fontawesome-brands-python: **clang-tools-wheels**
6878

6979
---
7080

71-
Easy installation of clang tools Python wheels via pip
81+
Distribution clang tools Python wheels for various platforms
7282

73-
[Learn More](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary }
83+
[Download from →](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary }
7484

7585
</div>
7686

@@ -86,14 +96,14 @@ cpp-linter is an open-source organization dedicated to providing high-quality to
8696

8797
Easy installation of clang tools static binaries via pip
8898

89-
[Learn More](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary }
99+
[Get started with clang-tools CLI →](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary }
90100

91101
- :fontawesome-brands-python: **clang-tools-asdf**
92102

93103
---
94104

95105
Easy installation of clang tools static binaries via asdf
96106

97-
[Learn More](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary }
107+
[Get started with asdf →](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary }
98108

99109
</div>

‎docs/index.md‎

Lines changed: 145 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,161 @@
1-
<!-- markdownlint-disable MD036 MD041 MD033 -->
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
26

3-
<p align="left">
4-
<img src="/static/readme-banner-small.png" width="512" height="141" alt="cpp-linter_brand_logo" />
5-
</p>
7+
<div class="hero" markdown>
68

7-
---
9+
# C/C++ linting that simply works
10+
11+
**Professional static analysis for C/C++ code – automated, configurable, and fast. Integrate seamlessly into any workflow in minutes.**
12+
13+
[Get started :material-rocket-launch:](getting-started.md){ .md-button .md-button--primary }
14+
15+
</div>
16+
17+
<div class="grid cards" markdown>
18+
19+
- :material-github: **GitHub Action**
20+
21+
---
22+
23+
Automated C++ linting in your CI/CD pipelines with zero configuration
24+
25+
[:octicons-arrow-right-24: cpp-linter-action](https://cpp-linter.github.io/cpp-linter-action/)
26+
27+
- :material-git: **Pre-commit Hooks**
28+
29+
---
30+
31+
Catch issues before they reach your repository with Git hooks
32+
33+
[:octicons-arrow-right-24: cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks)
34+
35+
- :fontawesome-brands-python: **Python Package**
36+
37+
---
38+
39+
Powerful command-line tool and Python API for local development
40+
41+
[:octicons-arrow-right-24: cpp-linter](https://cpp-linter.github.io/cpp-linter/)
42+
43+
44+
</div>
845

9-
## Cpp Linter
46+
## Everything you need for C/C++ code quality
1047

11-
**Automated linting for your C/C++ code**
48+
<div class="grid cards" markdown>
1249

13-
### Get Started
50+
- :material-chart-line: **Built in Open Source**
1451

15-
Integrate Cpp Linter into your workflow with:
52+
---
1653

17-
* [cpp-linter-action](https://github.com/cpp-linter/cpp-linter-action) — GitHub Action for CI pipelines
18-
* [cpp-linter-hooks](https://github.com/cpp-linter/cpp-linter-hooks) — Pre-commit hooks for local development
54+
Open-source and permissively licensed. Bringing contributors together to empower impactful C/C++ lint projects in open source and beyond.
1955

20-
### Clang Tools — Simplified
56+
- :material-cog: **Zero Configuration**
2157

22-
We provide ready-to-use **binaries**, **Docker images**, and **Python wheels** of key `clang-tools`:
58+
---
2359

24-
* [clang-tools-static-binaries](https://github.com/cpp-linter/clang-tools-static-binaries)
25-
* [clang-tools-docker](https://github.com/cpp-linter/clang-tools-docker)
26-
* [clang-tools-wheel](https://github.com/cpp-linter/clang-tools-wheel)
60+
Works out of the box with sensible defaults. Advanced users can customize every aspect to match their coding standards.
2761

28-
### Easy Installation
62+
- :material-devices: **Works Everywhere**
63+
64+
---
65+
66+
GitHub Actions, Pre-commit, Command Line, Docker containers – integrate anywhere your code lives.
67+
68+
</div>
69+
70+
## Clang Tools Made Simple
71+
72+
**No more complex installations or version conflicts.** Get `clang-format`, `clang-tidy`, `clang-query`, and more through your favorite package manager:
73+
74+
<div class="grid" markdown>
75+
76+
<div class="card-content" markdown>
77+
### :fontawesome-brands-python: **pip**
78+
```bash
79+
pip install clang-tools
80+
clang-tools --install 20
81+
```
82+
[:octicons-arrow-right-24: clang-tools-pip](https://github.com/cpp-linter/clang-tools-pip)
83+
</div>
84+
85+
<div class="card-content" markdown>
86+
### :material-docker: **Docker**
87+
```bash
88+
docker pull xianpengshen/clang-tools
89+
```
90+
[:octicons-arrow-right-24: clang-tools-docker](https://github.com/cpp-linter/clang-tools-docker)
91+
</div>
92+
93+
<div class="card-content" markdown>
94+
### :material-download: **Python Wheels**
95+
```bash
96+
pip install clang-<name>-<version>.whl
97+
```
98+
[:octicons-arrow-right-24: clang-tools-wheel](https://github.com/cpp-linter/clang-tools-wheel)
99+
</div>
100+
101+
</div>
102+
103+
## Quick Start
104+
105+
=== "GitHub Actions"
106+
107+
Add cpp-linter-action to your workflow in seconds:
108+
109+
```yaml
110+
steps:
111+
- uses: actions/checkout@v5
112+
- uses: cpp-linter/cpp-linter-action@v2
113+
id: linter
114+
env:
115+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
116+
with:
117+
style: 'file' # Use .clang-format config file
118+
tidy-checks: '' # Use .clang-tidy config file
119+
# only 'update' a single comment in a pull request thread.
120+
thread-comments: ${{ github.event_name == 'pull_request' && 'update' }}
121+
- name: Fail fast?!
122+
if: steps.linter.outputs.checks-failed > 0
123+
run: exit 1
124+
```
125+
=== "Pre-commit"
126+
127+
Add to your `.pre-commit-config.yaml`:
128+
129+
```yaml
130+
repos:
131+
- repo: https://github.com/cpp-linter/cpp-linter-hooks
132+
rev: v1.1.3 # Use the tag or commit you want
133+
hooks:
134+
- id: clang-format
135+
args: [--style=Google] # Other coding style: LLVM, GNU, Chromium, Microsoft, Mozilla, WebKit.
136+
- id: clang-tidy
137+
args: [--checks='boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*']
138+
```
139+
140+
=== "Command Line"
141+
142+
Install and run locally:
143+
144+
```bash
145+
pip install cpp-linter
146+
cpp-linter --style=file --tidy-checks='-*,readability-*' src/
147+
```
148+
149+
---
29150

30-
Prefer modern package managers? Install `clang-format`, `clang-tidy`, `clang-query`, and more via:
151+
<div class="community-section" markdown>
31152

32-
* [pip](https://github.com/cpp-linter/clang-tools-pip)
33-
* [asdf](https://github.com/cpp-linter/asdf-clang-tools)
153+
## Join Our Community
34154

35-
## Contributing 💪
155+
**Be part of a growing ecosystem of C/C++ developers who care about code quality.**
36156

37-
Thanks for your interest in contributing to [cpp-linter](https://github.com/cpp-linter)!
157+
[GitHub Discussions :fontawesome-brands-github:](https://github.com/cpp-linter/cpp-linter/discussions){ .md-button }
158+
<!-- [Discord Community :fontawesome-brands-discord:](https://discord.gg/cpp-linter){ .md-button }
159+
[Stack Overflow :fontawesome-brands-stack-overflow:](https://stackoverflow.com/questions/tagged/cpp-linter){ .md-button } -->
38160

39-
We welcome feedback, bug reports, and feature requests from the community!
161+
</div>

‎docs/stylesheets/extra.css‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,87 @@ th {
22
background-color: var(--md-default-fg-color--lightest);
33
}
44

5+
/* Hero section styling */
6+
.hero {
7+
text-align: center;
8+
padding: 4rem 0;
9+
background: linear-gradient(135deg, var(--md-primary-fg-color) 0%, var(--md-accent-fg-color) 100%);
10+
background-size: 200% 200%;
11+
animation: gradientShift 8s ease infinite;
12+
color: white;
13+
margin: -1.5rem -1.5rem 3rem -1.5rem;
14+
border-radius: 0 0 1rem 1rem;
15+
}
16+
17+
.hero h1 {
18+
font-size: 3rem;
19+
font-weight: 700;
20+
margin-bottom: 1rem;
21+
text-shadow: 0 2px 4px rgba(0,0,0,0.3);
22+
}
23+
24+
.hero p {
25+
font-size: 1.2rem;
26+
margin-bottom: 2rem;
27+
opacity: 0.9;
28+
max-width: 600px;
29+
margin-left: auto;
30+
margin-right: auto;
31+
}
32+
33+
@keyframes gradientShift {
34+
0% { background-position: 0% 50%; }
35+
50% { background-position: 100% 50%; }
36+
100% { background-position: 0% 50%; }
37+
}
38+
39+
/* Card enhancements */
40+
.md-typeset .grid.cards > .card-content {
41+
background: var(--md-default-bg-color);
42+
border: 1px solid var(--md-default-fg-color--lightest);
43+
border-radius: 0.5rem;
44+
padding: 1.5rem;
45+
transition: all 0.3s ease;
46+
}
47+
48+
.md-typeset .grid.cards > .card-content:hover {
49+
transform: translateY(-2px);
50+
box-shadow: 0 8px 25px rgba(0,0,0,0.1);
51+
border-color: var(--md-primary-fg-color);
52+
}
53+
54+
/* Community section styling */
55+
.community-section {
56+
background: var(--md-default-fg-color--lightest);
57+
padding: 3rem 2rem;
58+
margin: 3rem -1.5rem 0 -1.5rem;
59+
text-align: center;
60+
border-radius: 1rem 1rem 0 0;
61+
}
62+
63+
.community-section h2 {
64+
color: var(--md-primary-fg-color);
65+
margin-bottom: 1rem;
66+
}
67+
68+
/* Code block enhancements */
69+
.md-typeset pre > code {
70+
border-radius: 0.5rem;
71+
}
72+
73+
/* Button styling improvements */
74+
.md-button {
75+
border-radius: 2rem;
76+
padding: 0.5rem 1.5rem;
77+
font-weight: 500;
78+
transition: all 0.3s ease;
79+
}
80+
81+
.md-button:hover {
82+
transform: translateY(-1px);
83+
box-shadow: 0 4px 12px rgba(0,0,0,0.15);
84+
}
85+
586
.md-header {
687
background-color: #4051b5;
788
}

0 commit comments

Comments
 (0)