Skip to content

Commit 6251dc5

Browse files
authored
style: give buttons a clear hierarchy and mark external links (#50)
## What On the Getting Started page, every call-to-action button was rendered as a filled **primary** button. When everything is primary, nothing is — the eye has no anchor and the page reads as a wall of equally-weighted blue buttons. This PR introduces a visual hierarchy and distinguishes links that leave the docs site. ### Button hierarchy Keep the filled `.md-button--primary` style on just **two** buttons — the recommended entry point in each of the two decision areas: - **GitHub Actions** — the recommended integration in *Choose Your Integration* - **clang-tools-pip** — the recommended installer in *Install the clang tools* Every other button is demoted to the outlined `.md-button` style, so each section now has one obvious primary action and a set of clearly-secondary alternatives. ### External-link marking Buttons that navigate away from the docs site (to `github.com` / `pypi.org`) now end with an external-link icon (`:octicons-link-external-16:`) instead of the `→` arrow. The two in-ecosystem `cpp-linter.github.io` links keep the `→`, signalling "you're staying on the docs site." ## Why - Clearer guidance: a first-time visitor is steered toward the two recommended paths instead of facing a dozen equal choices. - Honest affordances: users know before clicking whether a button keeps them on the docs or sends them to GitHub/PyPI. ## Notes Content, links, and card structure are unchanged — this is purely a styling/affordance pass. --- _Generated by [Claude Code](https://claude.ai/code/session_012uXrN1wk5EaqK5GimN3deT)_
1 parent 07c8a1b commit 6251dc5

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/getting-started.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Select the method that best fits your development workflow:
4444

4545
**Perfect for:** Catching issues before commits, local enforcement
4646

47-
[Get started with pre-commit ](https://github.com/cpp-linter/cpp-linter-hooks){ .md-button .md-button--primary }
47+
[Get started with pre-commit :octicons-link-external-16:](https://github.com/cpp-linter/cpp-linter-hooks){ .md-button }
4848

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

@@ -54,7 +54,7 @@ Select the method that best fits your development workflow:
5454

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

57-
[Get started with cpp-linter package ](https://pypi.org/project/cpp-linter/){ .md-button .md-button--primary }
57+
[Get started with cpp-linter package :octicons-link-external-16:](https://pypi.org/project/cpp-linter/){ .md-button }
5858

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

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

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

67-
[Get started with cpp-linter-rs ](https://github.com/cpp-linter/cpp-linter-rs){ .md-button .md-button--primary }
67+
[Get started with cpp-linter-rs :octicons-link-external-16:](https://github.com/cpp-linter/cpp-linter-rs){ .md-button }
6868

6969
</div>
7070

@@ -91,15 +91,15 @@ Choose whichever fits your setup.
9191

9292
Install `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` via Homebrew — no compilation required
9393

94-
[Get started with Homebrew ](https://github.com/cpp-linter/homebrew-tap){ .md-button .md-button--primary }
94+
[Get started with Homebrew :octicons-link-external-16:](https://github.com/cpp-linter/homebrew-tap){ .md-button }
9595

9696
- :fontawesome-brands-python: **clang-tools-asdf**
9797

9898
---
9999

100100
Easy installation of clang tools static binaries via asdf
101101

102-
[Get started with asdf ](https://github.com/cpp-linter/asdf-clang-tools){ .md-button .md-button--primary }
102+
[Get started with asdf :octicons-link-external-16:](https://github.com/cpp-linter/asdf-clang-tools){ .md-button }
103103

104104
</div>
105105

@@ -113,23 +113,23 @@ Choose whichever fits your setup.
113113

114114
Statically-linked `clang-format`, `clang-tidy`, `clang-query`, `clang-apply-replacements`, and `clang-include-cleaner` binaries for Linux, macOS, and Windows
115115

116-
[Download from ](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary }
116+
[Download from :octicons-link-external-16:](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button }
117117

118118
- :fontawesome-brands-docker: **clang-tools-docker**
119119

120120
---
121121

122122
Docker images with pre-installed `clang-format` and `clang-tidy`
123123

124-
[Download from ](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary }
124+
[Download from :octicons-link-external-16:](https://github.com/cpp-linter/clang-tools-docker){ .md-button }
125125

126126
- :fontawesome-brands-python: **clang-tools-wheels**
127127

128128
---
129129

130130
Redistribute `clang-format` and `clang-tidy` Python wheels
131131

132-
[Download from ](https://github.com/cpp-linter/clang-tools-wheel){ .md-button .md-button--primary }
132+
[Download from :octicons-link-external-16:](https://github.com/cpp-linter/clang-tools-wheel){ .md-button }
133133

134134
</div>
135135

@@ -143,14 +143,14 @@ Choose whichever fits your setup.
143143

144144
Install `clang-apply-replacements` via pip — standalone Python wheel
145145

146-
[Install from PyPI ](https://pypi.org/project/clang-apply-replacements/){ .md-button .md-button--primary }
146+
[Install from PyPI :octicons-link-external-16:](https://pypi.org/project/clang-apply-replacements/){ .md-button }
147147

148148
- :fontawesome-brands-python: **clang-include-cleaner**
149149

150150
---
151151

152152
Install `clang-include-cleaner` via pip — detects unused `#include` directives
153153

154-
[Install from PyPI ](https://pypi.org/project/clang-include-cleaner/){ .md-button .md-button--primary }
154+
[Install from PyPI :octicons-link-external-16:](https://pypi.org/project/clang-include-cleaner/){ .md-button }
155155

156156
</div>

0 commit comments

Comments
 (0)