From bfc7a47f5da0f9b8c9987d21ae70c2e9b794e4cd Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Sun, 28 Sep 2025 20:59:03 -0700 Subject: [PATCH 1/5] fix: hero rendering * Better color choice for anti-aliasing. * Better size and positioning for mobile and desktop. * Update mkdocs.yml config to silence warnings about unused documents (`blog/**`) * Update `repo_name` in mkdocs.yml to display GitHub org name instead of the generic default ("Github") * Disable markdownlint warnings as needed. --- docs/getting-started.md | 26 ++++++++----------- docs/index.md | 31 +++++++++++++++++++--- docs/stylesheets/extra.css | 53 ++++++++++++++++++++++++-------------- mkdocs.yml | 8 +++--- 4 files changed, 77 insertions(+), 41 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 11c4416..fae91c6 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,11 +4,13 @@ Welcome to cpp-linter! This guide will help you integrate C/C++ linting into you ## Choose Your Integration + + Select the method that best fits your development workflow:
-- :material-github: **GitHub Actions** +- :material-github: **GitHub Actions** --- @@ -18,8 +20,7 @@ Select the method that best fits your development workflow: [Get started with GitHub Actions →](https://cpp-linter.github.io/cpp-linter-action/){ .md-button .md-button--primary } - -- :material-git: **Pre-commit Hooks** +- :material-git: **Pre-commit Hooks** --- @@ -28,9 +29,8 @@ Select the method that best fits your development workflow: **Perfect for:** Catching issues before commits, local enforcement [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** --- @@ -40,7 +40,7 @@ Select the method that best fits your development workflow: [Get started with cpp-linter package →](https://cpp-linter.github.io/cpp-linter/){ .md-button .md-button--primary } -- :simple-rust: **Command Line (Rust)** +- :simple-rust: **Command Line (Rust)** --- @@ -56,7 +56,7 @@ Select the method that best fits your development workflow:
-- :fontawesome-brands-github: **clang-tools-static-binaries** +- :fontawesome-brands-github: **clang-tools-static-binaries** --- @@ -64,8 +64,7 @@ Select the method that best fits your development workflow: [Download from →](https://github.com/cpp-linter/clang-tools-static-binaries){ .md-button .md-button--primary } - -- :fontawesome-brands-docker: **clang-tools-docker** +- :fontawesome-brands-docker: **clang-tools-docker** --- @@ -73,8 +72,7 @@ Select the method that best fits your development workflow: [Download from →](https://github.com/cpp-linter/clang-tools-docker){ .md-button .md-button--primary } - -- :fontawesome-brands-python: **clang-tools-wheels** +- :fontawesome-brands-python: **clang-tools-wheels** --- @@ -84,13 +82,11 @@ Select the method that best fits your development workflow:
- - ## Easy Installation
-- :fontawesome-brands-python: **clang-tools-pip** +- :fontawesome-brands-python: **clang-tools-pip** --- @@ -98,7 +94,7 @@ Select the method that best fits your development workflow: [Get started with clang-tools CLI →](https://cpp-linter.github.io/clang-tools-pip/){ .md-button .md-button--primary } -- :fontawesome-brands-python: **clang-tools-asdf** +- :fontawesome-brands-python: **clang-tools-asdf** --- diff --git a/docs/index.md b/docs/index.md index caa8e2a..95c775d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,21 @@ hide: - toc --- + + +
# C/C++ linting that simply works @@ -22,19 +37,19 @@ hide:
-- :material-chart-line: **Built in Open Source** +- :material-chart-line: **Built in Open Source** --- Open-source and MIT-licensed. Bringing contributors together to empower impactful C/C++ lint projects in open source and beyond. -- :material-cog: **Zero Configuration** +- :material-cog: **Zero Configuration** --- Works out of the box with sensible defaults. Advanced users can customize every aspect to match their coding standards. -- :material-devices: **Works Everywhere** +- :material-devices: **Works Everywhere** --- @@ -138,7 +153,15 @@ hide: - id: clang-format args: [--style=Google] # Other coding style: LLVM, GNU, Chromium, Microsoft, Mozilla, WebKit. - id: clang-tidy - args: [--checks='boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*'] + args: + - --checks='boost-* + - bugprone-* + - performance-* + - readability-* + - portability-* + - modernize-* + - clang-analyzer-* + - cppcoreguidelines-*' ``` === "Command Line" diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 6d9cb81..52ff255 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -2,15 +2,21 @@ th { background-color: var(--md-default-fg-color--lightest); } +:root > * { + --cpp-linter-logo-color-green: #40b385; + --cpp-linter-logo-color-yellow: #ffc20a; +} + /* Hero section styling */ .hero { text-align: center; padding: 4rem 0; - background: linear-gradient(135deg, var(--md-primary-fg-color) 0%, var(--md-accent-fg-color) 100%); - background-size: 200% 200%; - animation: gradientShift 8s ease infinite; - color: white; - margin: -1.5rem -1.5rem 3rem -1.5rem; + /* background: linear-gradient(135deg, var(--md-primary-fg-color) 0%, var(--cpp-linter-logo-color-green) 100%); */ + /* background-size: 200% 200%; */ + /* animation: gradientShift 8s ease infinite; */ + background: var(--md-primary-fg-color); + color: var(--md-primary-bg-color); + margin: 0 -1em 3rem -1em; border-radius: 0 0 1rem 1rem; } @@ -19,17 +25,39 @@ th { font-weight: 700; margin-bottom: 1rem; text-shadow: 0 2px 4px rgba(0,0,0,0.3); + text-align: center; + color: unset; } .hero p { font-size: 1.2rem; margin-bottom: 2rem; opacity: 0.9; - max-width: 600px; + width: 65%; margin-left: auto; margin-right: auto; } +.hero .md-button:hover { + border: 2px solid black; +} + +.hero .md-button { + background: var(--cpp-linter-logo-color-green); + color: black; + border: none; +} + +.hero .md-button:hover { + background: var(--cpp-linter-logo-color-yellow); + color: black; + border: none; +} + +.md-typeset .md-button:hover { + color: black; +} + @keyframes gradientShift { 0% { background-position: 0% 50%; } 50% { background-position: 100% 50%; } @@ -184,19 +212,6 @@ th { } } -.md-header { - background-color: #4051b5; -} - -/* Make navigation tabs match header color */ -.md-tabs { - background-color: #4051b5; -} - -.md-tabs__list { - background-color: #4051b5; -} - /* Ensure tab items have proper contrast */ .md-tabs__item { background-color: transparent; diff --git a/mkdocs.yml b/mkdocs.yml index 1d7a8e8..986e573 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ site_name: "cpp-linter" site_description: "Documentation for the cpp-linter organization." site_url: "https://cpp-linter.github.io/" repo_url: https://github.com/cpp-linter - +repo_name: "cpp-linter" copyright: "© 2021-2025, cpp-linter" nav: @@ -11,6 +11,8 @@ nav: - Discussion: discussion.md # - Blog: # - blog/index.md +exclude_docs: | + blog/** theme: name: material @@ -35,7 +37,7 @@ theme: # Palette toggle for light mode - media: "(prefers-color-scheme: light)" scheme: default - primary: blue + primary: indigo accent: cyan toggle: icon: material/lightbulb-outline @@ -44,7 +46,7 @@ theme: # Palette toggle for dark mode - media: "(prefers-color-scheme: dark)" scheme: slate - primary: blue + primary: indigo accent: cyan toggle: icon: material/lightbulb From 90157cc0419c5925697d1f46874a89d1e66743ac Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Mon, 29 Sep 2025 00:04:07 -0700 Subject: [PATCH 2/5] override hero block in theme template --- docs/index.md | 28 +--------------------------- docs/overrides/home.html | 20 ++++++++++++++++++++ docs/stylesheets/extra.css | 13 +++++++++---- mkdocs.yml | 2 ++ 4 files changed, 32 insertions(+), 31 deletions(-) create mode 100644 docs/overrides/home.html diff --git a/docs/index.md b/docs/index.md index 95c775d..7d9937f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,37 +2,11 @@ hide: - navigation - toc +template: home.html --- - -
- -# C/C++ linting that simply works - -**Lint your C/C++ code in workflow** - automated, configurable, and reliable. Integrate seamlessly into any workflow in minutes. - -[Get started :material-rocket-launch:](getting-started.md){ .md-button .md-button--primary } - -
- -
- -
- ## Everything you need for linting C/C++ code
diff --git a/docs/overrides/home.html b/docs/overrides/home.html new file mode 100644 index 0000000..525278f --- /dev/null +++ b/docs/overrides/home.html @@ -0,0 +1,20 @@ +{% extends "main.html" %} + +{% block hero %} +
+

C/C++ linting that simply works

+

+ Lint your C/C++ code in your development workflow + - automated, configurable, and reliable. + Integrate seamlessly into any development workflow in minutes. +

+

+ + Get started + + + + +

+
+{% endblock %} diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 52ff255..e400825 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -5,6 +5,7 @@ th { :root > * { --cpp-linter-logo-color-green: #40b385; --cpp-linter-logo-color-yellow: #ffc20a; + --rocket: url('data:image/svg+xml,' ) } /* Hero section styling */ @@ -16,8 +17,8 @@ th { /* animation: gradientShift 8s ease infinite; */ background: var(--md-primary-fg-color); color: var(--md-primary-bg-color); - margin: 0 -1em 3rem -1em; - border-radius: 0 0 1rem 1rem; + /* margin: 0 -1em 3rem -1em; */ + /* border-radius: 0 0 1rem 1rem; */ } .hero h1 { @@ -38,14 +39,18 @@ th { margin-right: auto; } -.hero .md-button:hover { - border: 2px solid black; +.hero .twemoji { + --md-icon-size: 1.125em; + display: inline-flex; + height: var(--md-icon-size); + vertical-align: text-top; } .hero .md-button { background: var(--cpp-linter-logo-color-green); color: black; border: none; + border-radius: unset; } .hero .md-button:hover { diff --git a/mkdocs.yml b/mkdocs.yml index 986e573..0eaf710 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -16,8 +16,10 @@ exclude_docs: | theme: name: material + custom_dir: docs/overrides features: - navigation.tabs + - navigation.tabs.sticky - toc.integrate - navigation.top - navigation.sections From e328386d62c5b8de3c6edf18292bf94b9a04c4ed Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Mon, 29 Sep 2025 00:11:23 -0700 Subject: [PATCH 3/5] fix word-wrapping overflow in hero button --- docs/stylesheets/extra.css | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index e400825..e26d385 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -51,6 +51,7 @@ th { color: black; border: none; border-radius: unset; + display: block; } .hero .md-button:hover { From f2424dca5597ef0018c7a5e4e3dbe5dce545bb84 Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Mon, 29 Sep 2025 00:27:50 -0700 Subject: [PATCH 4/5] another review on mobile and code cleanup --- docs/index.md | 5 ++++- docs/stylesheets/extra.css | 8 +------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/index.md b/docs/index.md index 7d9937f..11f2840 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,9 +3,12 @@ hide: - navigation - toc template: home.html +title: C/C++ Linting --- - + + +# C/C++ Linting ## Everything you need for linting C/C++ code diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index e26d385..d6c1b22 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -5,20 +5,14 @@ th { :root > * { --cpp-linter-logo-color-green: #40b385; --cpp-linter-logo-color-yellow: #ffc20a; - --rocket: url('data:image/svg+xml,' ) } /* Hero section styling */ .hero { text-align: center; padding: 4rem 0; - /* background: linear-gradient(135deg, var(--md-primary-fg-color) 0%, var(--cpp-linter-logo-color-green) 100%); */ - /* background-size: 200% 200%; */ - /* animation: gradientShift 8s ease infinite; */ background: var(--md-primary-fg-color); color: var(--md-primary-bg-color); - /* margin: 0 -1em 3rem -1em; */ - /* border-radius: 0 0 1rem 1rem; */ } .hero h1 { @@ -51,7 +45,7 @@ th { color: black; border: none; border-radius: unset; - display: block; + display: inline-block; } .hero .md-button:hover { From 5fd1fb64237355b8359b09f7fb066e0b3864bdff Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Mon, 29 Sep 2025 00:36:06 -0700 Subject: [PATCH 5/5] adjust CI to use official GH actions --- .github/workflows/deploy.yml | 47 ++++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 15 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index c9da2c3..c6bc90d 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,32 +1,49 @@ name: Deploy Documentation on: push: - branches: - - main # Set the branch you want to trigger the deployment + branches: [main] + pull_request: + branches: [main] jobs: - deploy: + build: runs-on: ubuntu-latest steps: - name: Checkout Repository uses: actions/checkout@v5 - + with: + persist-credentials: false + - name: Set up Python uses: actions/setup-python@v4 with: python-version: '3.x' - + - name: Install Dependencies - run: | - python -m pip install --upgrade pip - pip install nox - nox -s docs + run: pipx run nox -s docs + - name: Upload docs build as artifact + uses: actions/upload-pages-artifact@v4 + with: + name: ${{ github.event.repository.name }}_docs + path: ${{ github.workspace }}/site + + deploy: + if: github.ref == 'refs/heads/main' + runs-on: ubuntu-latest + needs: [build] + permissions: + # to deploy to Pages + pages: write + # to verify the deployment originates from an appropriate source + id-token: write + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v4 + id: deployment + uses: actions/deploy-pages@v4 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./site - user_name: 'github-actions[bot]' - user_email: 'github-actions[bot]@users.noreply.github.com' - commit_message: 'Deploy documentation' + artifact_name: ${{ github.event.repository.name }}_docs